amazonka-config-2.0: Amazon Config SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Config.Lens

Contents

Description

 
Synopsis

Operations

BatchGetAggregateResourceConfig

batchGetAggregateResourceConfigResponse_unprocessedResourceIdentifiers :: Lens' BatchGetAggregateResourceConfigResponse (Maybe [AggregateResourceIdentifier]) Source #

A list of resource identifiers that were not processed with current scope. The list is empty if all the resources are processed.

BatchGetResourceConfig

batchGetResourceConfig_resourceKeys :: Lens' BatchGetResourceConfig (NonEmpty ResourceKey) Source #

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.

batchGetResourceConfigResponse_baseConfigurationItems :: Lens' BatchGetResourceConfigResponse (Maybe [BaseConfigurationItem]) Source #

A list that contains the current configuration of one or more resources.

batchGetResourceConfigResponse_unprocessedResourceKeys :: Lens' BatchGetResourceConfigResponse (Maybe (NonEmpty ResourceKey)) Source #

A list of resource keys that were not processed with the current response. The unprocessesResourceKeys value is in the same form as ResourceKeys, so the value can be directly provided to a subsequent BatchGetResourceConfig operation. If there are no unprocessed resource keys, the response contains an empty unprocessedResourceKeys list.

DeleteAggregationAuthorization

deleteAggregationAuthorization_authorizedAccountId :: Lens' DeleteAggregationAuthorization Text Source #

The 12-digit account ID of the account authorized to aggregate data.

DeleteConfigRule

deleteConfigRule_configRuleName :: Lens' DeleteConfigRule Text Source #

The name of the Config rule that you want to delete.

DeleteConfigurationAggregator

DeleteConfigurationRecorder

deleteConfigurationRecorder_configurationRecorderName :: Lens' DeleteConfigurationRecorder Text Source #

The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.

DeleteConformancePack

deleteConformancePack_conformancePackName :: Lens' DeleteConformancePack Text Source #

Name of the conformance pack you want to delete.

DeleteDeliveryChannel

DeleteEvaluationResults

deleteEvaluationResults_configRuleName :: Lens' DeleteEvaluationResults Text Source #

The name of the Config rule for which you want to delete the evaluation results.

DeleteOrganizationConfigRule

deleteOrganizationConfigRule_organizationConfigRuleName :: Lens' DeleteOrganizationConfigRule Text Source #

The name of organization Config rule that you want to delete.

DeleteOrganizationConformancePack

DeletePendingAggregationRequest

deletePendingAggregationRequest_requesterAccountId :: Lens' DeletePendingAggregationRequest Text Source #

The 12-digit account ID of the account requesting to aggregate data.

DeleteRemediationConfiguration

deleteRemediationConfiguration_configRuleName :: Lens' DeleteRemediationConfiguration Text Source #

The name of the Config rule for which you want to delete remediation configuration.

DeleteRemediationExceptions

deleteRemediationExceptions_configRuleName :: Lens' DeleteRemediationExceptions Text Source #

The name of the Config rule for which you want to delete remediation exception configuration.

deleteRemediationExceptions_resourceKeys :: Lens' DeleteRemediationExceptions (NonEmpty RemediationExceptionResourceKey) Source #

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

deleteRemediationExceptionsResponse_failedBatches :: Lens' DeleteRemediationExceptionsResponse (Maybe [FailedDeleteRemediationExceptionsBatch]) Source #

Returns a list of failed delete remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

DeleteResourceConfig

DeleteRetentionConfiguration

DeleteStoredQuery

deleteStoredQuery_queryName :: Lens' DeleteStoredQuery Text Source #

The name of the query that you want to delete.

DeliverConfigSnapshot

deliverConfigSnapshot_deliveryChannelName :: Lens' DeliverConfigSnapshot Text Source #

The name of the delivery channel through which the snapshot is delivered.

DescribeAggregateComplianceByConfigRules

describeAggregateComplianceByConfigRules_limit :: Lens' DescribeAggregateComplianceByConfigRules (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeAggregateComplianceByConfigRules_nextToken :: Lens' DescribeAggregateComplianceByConfigRules (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeAggregateComplianceByConfigRulesResponse_nextToken :: Lens' DescribeAggregateComplianceByConfigRulesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeAggregateComplianceByConformancePacks

describeAggregateComplianceByConformancePacks_limit :: Lens' DescribeAggregateComplianceByConformancePacks (Maybe Natural) Source #

The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeAggregateComplianceByConformancePacks_nextToken :: Lens' DescribeAggregateComplianceByConformancePacks (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeAggregateComplianceByConformancePacksResponse_nextToken :: Lens' DescribeAggregateComplianceByConformancePacksResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeAggregationAuthorizations

describeAggregationAuthorizations_limit :: Lens' DescribeAggregationAuthorizations (Maybe Natural) Source #

The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeAggregationAuthorizations_nextToken :: Lens' DescribeAggregationAuthorizations (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeAggregationAuthorizationsResponse_nextToken :: Lens' DescribeAggregationAuthorizationsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeComplianceByConfigRule

describeComplianceByConfigRule_complianceTypes :: Lens' DescribeComplianceByConfigRule (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT.

describeComplianceByConfigRule_configRuleNames :: Lens' DescribeComplianceByConfigRule (Maybe [Text]) Source #

Specify one or more Config rule names to filter the results by rule.

describeComplianceByConfigRule_nextToken :: Lens' DescribeComplianceByConfigRule (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeComplianceByConfigRuleResponse_nextToken :: Lens' DescribeComplianceByConfigRuleResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

DescribeComplianceByResource

describeComplianceByResource_complianceTypes :: Lens' DescribeComplianceByResource (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

describeComplianceByResource_limit :: Lens' DescribeComplianceByResource (Maybe Natural) Source #

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, Config uses the default.

describeComplianceByResource_nextToken :: Lens' DescribeComplianceByResource (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeComplianceByResource_resourceId :: Lens' DescribeComplianceByResource (Maybe Text) Source #

The ID of the Amazon Web Services 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 ResourceType.

describeComplianceByResource_resourceType :: Lens' DescribeComplianceByResource (Maybe Text) Source #

The types of Amazon Web Services resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

describeComplianceByResourceResponse_complianceByResources :: Lens' DescribeComplianceByResourceResponse (Maybe [ComplianceByResource]) Source #

Indicates whether the specified Amazon Web Services resource complies with all of the Config rules that evaluate it.

describeComplianceByResourceResponse_nextToken :: Lens' DescribeComplianceByResourceResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

DescribeConfigRuleEvaluationStatus

describeConfigRuleEvaluationStatus_configRuleNames :: Lens' DescribeConfigRuleEvaluationStatus (Maybe [Text]) Source #

The name of the Config managed rules for which you want status information. If you do not specify any names, Config returns status information for all Config managed rules that you use.

describeConfigRuleEvaluationStatus_limit :: Lens' DescribeConfigRuleEvaluationStatus (Maybe Natural) Source #

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 150 rules.

For information about requesting a rule limit increase, see Config Limits in the Amazon Web Services General Reference Guide.

describeConfigRuleEvaluationStatus_nextToken :: Lens' DescribeConfigRuleEvaluationStatus (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeConfigRuleEvaluationStatusResponse_nextToken :: Lens' DescribeConfigRuleEvaluationStatusResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

DescribeConfigRules

describeConfigRules_configRuleNames :: Lens' DescribeConfigRules (Maybe [Text]) Source #

The names of the Config rules for which you want details. If you do not specify any names, Config returns details for all your rules.

describeConfigRules_filters :: Lens' DescribeConfigRules (Maybe DescribeConfigRulesFilters) Source #

Returns a list of Detecive or Proactive Config rules. By default, this API returns an unfiltered list.

describeConfigRules_nextToken :: Lens' DescribeConfigRules (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeConfigRulesResponse_nextToken :: Lens' DescribeConfigRulesResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

DescribeConfigurationAggregatorSourcesStatus

describeConfigurationAggregatorSourcesStatus_limit :: Lens' DescribeConfigurationAggregatorSourcesStatus (Maybe Natural) Source #

The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeConfigurationAggregatorSourcesStatus_nextToken :: Lens' DescribeConfigurationAggregatorSourcesStatus (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeConfigurationAggregatorSourcesStatus_updateStatus :: Lens' DescribeConfigurationAggregatorSourcesStatus (Maybe (NonEmpty AggregatedSourceStatusType)) Source #

Filters the status type.

  • Valid value FAILED indicates errors while moving data.
  • Valid value SUCCEEDED indicates the data was successfully moved.
  • Valid value OUTDATED indicates the data is not the most recent.

describeConfigurationAggregatorSourcesStatusResponse_nextToken :: Lens' DescribeConfigurationAggregatorSourcesStatusResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeConfigurationAggregators

describeConfigurationAggregators_limit :: Lens' DescribeConfigurationAggregators (Maybe Natural) Source #

The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeConfigurationAggregators_nextToken :: Lens' DescribeConfigurationAggregators (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeConfigurationAggregatorsResponse_nextToken :: Lens' DescribeConfigurationAggregatorsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeConfigurationRecorderStatus

describeConfigurationRecorderStatus_configurationRecorderNames :: Lens' DescribeConfigurationRecorderStatus (Maybe [Text]) Source #

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.

DescribeConfigurationRecorders

describeConfigurationRecordersResponse_configurationRecorders :: Lens' DescribeConfigurationRecordersResponse (Maybe [ConfigurationRecorder]) Source #

A list that contains the descriptions of the specified configuration recorders.

DescribeConformancePackCompliance

describeConformancePackCompliance_limit :: Lens' DescribeConformancePackCompliance (Maybe Natural) Source #

The maximum number of Config rules within a conformance pack are returned on each page.

describeConformancePackCompliance_nextToken :: Lens' DescribeConformancePackCompliance (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

describeConformancePackComplianceResponse_nextToken :: Lens' DescribeConformancePackComplianceResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

DescribeConformancePackStatus

describeConformancePackStatus_limit :: Lens' DescribeConformancePackStatus (Maybe Natural) Source #

The maximum number of conformance packs status returned on each page.

describeConformancePackStatus_nextToken :: Lens' DescribeConformancePackStatus (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

describeConformancePackStatusResponse_nextToken :: Lens' DescribeConformancePackStatusResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

DescribeConformancePacks

describeConformancePacks_conformancePackNames :: Lens' DescribeConformancePacks (Maybe [Text]) Source #

Comma-separated list of conformance pack names for which you want details. If you do not specify any names, Config returns details for all your conformance packs.

describeConformancePacks_limit :: Lens' DescribeConformancePacks (Maybe Natural) Source #

The maximum number of conformance packs returned on each page.

describeConformancePacks_nextToken :: Lens' DescribeConformancePacks (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

describeConformancePacksResponse_nextToken :: Lens' DescribeConformancePacksResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

DescribeDeliveryChannelStatus

DescribeDeliveryChannels

describeDeliveryChannelsResponse_deliveryChannels :: Lens' DescribeDeliveryChannelsResponse (Maybe [DeliveryChannel]) Source #

A list that contains the descriptions of the specified delivery channel.

DescribeOrganizationConfigRuleStatuses

describeOrganizationConfigRuleStatuses_limit :: Lens' DescribeOrganizationConfigRuleStatuses (Maybe Natural) Source #

The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

describeOrganizationConfigRuleStatuses_nextToken :: Lens' DescribeOrganizationConfigRuleStatuses (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConfigRuleStatuses_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRuleStatuses (Maybe [Text]) Source #

The names of organization Config rules for which you want status details. If you do not specify any names, Config returns details for all your organization Config rules.

describeOrganizationConfigRuleStatusesResponse_nextToken :: Lens' DescribeOrganizationConfigRuleStatusesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeOrganizationConfigRules

describeOrganizationConfigRules_limit :: Lens' DescribeOrganizationConfigRules (Maybe Natural) Source #

The maximum number of organization Config rules returned on each page. If you do no specify a number, Config uses the default. The default is 100.

describeOrganizationConfigRules_nextToken :: Lens' DescribeOrganizationConfigRules (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConfigRules_organizationConfigRuleNames :: Lens' DescribeOrganizationConfigRules (Maybe [Text]) Source #

The names of organization Config rules for which you want details. If you do not specify any names, Config returns details for all your organization Config rules.

describeOrganizationConfigRulesResponse_nextToken :: Lens' DescribeOrganizationConfigRulesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeOrganizationConformancePackStatuses

describeOrganizationConformancePackStatuses_limit :: Lens' DescribeOrganizationConformancePackStatuses (Maybe Natural) Source #

The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, Config uses the default. The default is 100.

describeOrganizationConformancePackStatuses_nextToken :: Lens' DescribeOrganizationConformancePackStatuses (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConformancePackStatuses_organizationConformancePackNames :: Lens' DescribeOrganizationConformancePackStatuses (Maybe [Text]) Source #

The names of organization conformance packs for which you want status details. If you do not specify any names, Config returns details for all your organization conformance packs.

describeOrganizationConformancePackStatusesResponse_nextToken :: Lens' DescribeOrganizationConformancePackStatusesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeOrganizationConformancePacks

describeOrganizationConformancePacks_limit :: Lens' DescribeOrganizationConformancePacks (Maybe Natural) Source #

The maximum number of organization config packs returned on each page. If you do no specify a number, Config uses the default. The default is 100.

describeOrganizationConformancePacks_nextToken :: Lens' DescribeOrganizationConformancePacks (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeOrganizationConformancePacksResponse_nextToken :: Lens' DescribeOrganizationConformancePacksResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribePendingAggregationRequests

describePendingAggregationRequests_limit :: Lens' DescribePendingAggregationRequests (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, Config uses the default.

describePendingAggregationRequests_nextToken :: Lens' DescribePendingAggregationRequests (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describePendingAggregationRequestsResponse_nextToken :: Lens' DescribePendingAggregationRequestsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeRemediationConfigurations

describeRemediationConfigurations_configRuleNames :: Lens' DescribeRemediationConfigurations [Text] Source #

A list of Config rule names of remediation configurations for which you want details.

DescribeRemediationExceptions

describeRemediationExceptions_limit :: Lens' DescribeRemediationExceptions (Maybe Natural) Source #

The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, Config uses the default.

describeRemediationExceptions_nextToken :: Lens' DescribeRemediationExceptions (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

describeRemediationExceptions_resourceKeys :: Lens' DescribeRemediationExceptions (Maybe (NonEmpty RemediationExceptionResourceKey)) Source #

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

describeRemediationExceptionsResponse_nextToken :: Lens' DescribeRemediationExceptionsResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

DescribeRemediationExecutionStatus

describeRemediationExecutionStatus_limit :: Lens' DescribeRemediationExecutionStatus (Maybe Natural) Source #

The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.

describeRemediationExecutionStatus_nextToken :: Lens' DescribeRemediationExecutionStatus (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeRemediationExecutionStatus_resourceKeys :: Lens' DescribeRemediationExecutionStatus (Maybe (NonEmpty ResourceKey)) Source #

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.

describeRemediationExecutionStatusResponse_nextToken :: Lens' DescribeRemediationExecutionStatusResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

DescribeRetentionConfigurations

describeRetentionConfigurations_nextToken :: Lens' DescribeRetentionConfigurations (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

describeRetentionConfigurations_retentionConfigurationNames :: Lens' DescribeRetentionConfigurations (Maybe [Text]) Source #

A list of names of retention configurations for which you want details. If you do not specify a name, Config returns details for all the retention configurations for that account.

Currently, Config supports only one retention configuration per region in your account.

describeRetentionConfigurationsResponse_nextToken :: Lens' DescribeRetentionConfigurationsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetAggregateComplianceDetailsByConfigRule

getAggregateComplianceDetailsByConfigRule_complianceType :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe ComplianceType) Source #

The resource compliance status.

For the GetAggregateComplianceDetailsByConfigRuleRequest data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA values.

getAggregateComplianceDetailsByConfigRule_limit :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe Natural) Source #

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, Config uses the default.

getAggregateComplianceDetailsByConfigRule_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRule (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getAggregateComplianceDetailsByConfigRule_configRuleName :: Lens' GetAggregateComplianceDetailsByConfigRule Text Source #

The name of the Config rule for which you want compliance information.

getAggregateComplianceDetailsByConfigRuleResponse_nextToken :: Lens' GetAggregateComplianceDetailsByConfigRuleResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetAggregateConfigRuleComplianceSummary

getAggregateConfigRuleComplianceSummary_limit :: Lens' GetAggregateConfigRuleComplianceSummary (Maybe Natural) Source #

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, Config uses the default.

getAggregateConfigRuleComplianceSummary_nextToken :: Lens' GetAggregateConfigRuleComplianceSummary (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getAggregateConfigRuleComplianceSummaryResponse_nextToken :: Lens' GetAggregateConfigRuleComplianceSummaryResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetAggregateConformancePackComplianceSummary

getAggregateConformancePackComplianceSummary_limit :: Lens' GetAggregateConformancePackComplianceSummary (Maybe Natural) Source #

The maximum number of results returned on each page. The default is maximum. If you specify 0, Config uses the default.

getAggregateConformancePackComplianceSummary_nextToken :: Lens' GetAggregateConformancePackComplianceSummary (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getAggregateConformancePackComplianceSummaryResponse_groupByKey :: Lens' GetAggregateConformancePackComplianceSummaryResponse (Maybe Text) Source #

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

getAggregateConformancePackComplianceSummaryResponse_nextToken :: Lens' GetAggregateConformancePackComplianceSummaryResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetAggregateDiscoveredResourceCounts

getAggregateDiscoveredResourceCounts_limit :: Lens' GetAggregateDiscoveredResourceCounts (Maybe Natural) Source #

The maximum number of GroupedResourceCount objects returned on each page. The default is 1000. You cannot specify a number greater than 1000. If you specify 0, Config uses the default.

getAggregateDiscoveredResourceCounts_nextToken :: Lens' GetAggregateDiscoveredResourceCounts (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getAggregateDiscoveredResourceCountsResponse_groupByKey :: Lens' GetAggregateDiscoveredResourceCountsResponse (Maybe Text) Source #

The key passed into the request object. If GroupByKey is not provided, the result will be empty.

getAggregateDiscoveredResourceCountsResponse_nextToken :: Lens' GetAggregateDiscoveredResourceCountsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getAggregateDiscoveredResourceCountsResponse_totalDiscoveredResources :: Lens' GetAggregateDiscoveredResourceCountsResponse Integer Source #

The total number of resources that are present in an aggregator with the filters that you provide.

GetAggregateResourceConfig

GetComplianceDetailsByConfigRule

getComplianceDetailsByConfigRule_complianceTypes :: Lens' GetComplianceDetailsByConfigRule (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

getComplianceDetailsByConfigRule_limit :: Lens' GetComplianceDetailsByConfigRule (Maybe Natural) Source #

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, Config uses the default.

getComplianceDetailsByConfigRule_nextToken :: Lens' GetComplianceDetailsByConfigRule (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getComplianceDetailsByConfigRule_configRuleName :: Lens' GetComplianceDetailsByConfigRule Text Source #

The name of the Config rule for which you want compliance information.

getComplianceDetailsByConfigRuleResponse_evaluationResults :: Lens' GetComplianceDetailsByConfigRuleResponse (Maybe [EvaluationResult]) Source #

Indicates whether the Amazon Web Services resource complies with the specified Config rule.

getComplianceDetailsByConfigRuleResponse_nextToken :: Lens' GetComplianceDetailsByConfigRuleResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

GetComplianceDetailsByResource

getComplianceDetailsByResource_complianceTypes :: Lens' GetComplianceDetailsByResource (Maybe [ComplianceType]) Source #

Filters the results by compliance.

The allowed values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

getComplianceDetailsByResource_nextToken :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getComplianceDetailsByResource_resourceEvaluationId :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The unique ID of Amazon Web Services resource execution for which you want to retrieve evaluation results.

You need to only provide either a ResourceEvaluationID or a ResourceID and ResourceType.

getComplianceDetailsByResource_resourceId :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The ID of the Amazon Web Services resource for which you want compliance information.

getComplianceDetailsByResource_resourceType :: Lens' GetComplianceDetailsByResource (Maybe Text) Source #

The type of the Amazon Web Services resource for which you want compliance information.

getComplianceDetailsByResourceResponse_evaluationResults :: Lens' GetComplianceDetailsByResourceResponse (Maybe [EvaluationResult]) Source #

Indicates whether the specified Amazon Web Services resource complies each Config rule.

getComplianceDetailsByResourceResponse_nextToken :: Lens' GetComplianceDetailsByResourceResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

GetComplianceSummaryByConfigRule

getComplianceSummaryByConfigRuleResponse_complianceSummary :: Lens' GetComplianceSummaryByConfigRuleResponse (Maybe ComplianceSummary) Source #

The number of Config rules that are compliant and the number that are noncompliant, up to a maximum of 25 for each.

GetComplianceSummaryByResourceType

getComplianceSummaryByResourceType_resourceTypes :: Lens' GetComplianceSummaryByResourceType (Maybe [Text]) Source #

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.

For this request, you can specify an Amazon Web Services resource type such as AWS::EC2::Instance. You can specify that the resource type is an Amazon Web Services account by specifying AWS::::Account.

getComplianceSummaryByResourceTypeResponse_complianceSummariesByResourceType :: Lens' GetComplianceSummaryByResourceTypeResponse (Maybe [ComplianceSummaryByResourceType]) Source #

The number of resources that are compliant and the number that are noncompliant. If one or more resource types were provided with the request, the numbers are returned for each resource type. The maximum number returned is 100.

GetConformancePackComplianceDetails

getConformancePackComplianceDetails_limit :: Lens' GetConformancePackComplianceDetails (Maybe Natural) Source #

The maximum number of evaluation results returned on each page. If you do no specify a number, Config uses the default. The default is 100.

getConformancePackComplianceDetails_nextToken :: Lens' GetConformancePackComplianceDetails (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

getConformancePackComplianceDetailsResponse_nextToken :: Lens' GetConformancePackComplianceDetailsResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

GetConformancePackComplianceSummary

getConformancePackComplianceSummary_limit :: Lens' GetConformancePackComplianceSummary (Maybe Natural) Source #

The maximum number of conformance packs returned on each page.

getConformancePackComplianceSummary_nextToken :: Lens' GetConformancePackComplianceSummary (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getConformancePackComplianceSummaryResponse_nextToken :: Lens' GetConformancePackComplianceSummaryResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetCustomRulePolicy

getCustomRulePolicy_configRuleName :: Lens' GetCustomRulePolicy (Maybe Text) Source #

The name of your Config Custom Policy rule.

getCustomRulePolicyResponse_policyText :: Lens' GetCustomRulePolicyResponse (Maybe Text) Source #

The policy definition containing the logic for your Config Custom Policy rule.

GetDiscoveredResourceCounts

getDiscoveredResourceCounts_limit :: Lens' GetDiscoveredResourceCounts (Maybe Natural) Source #

The maximum number of ResourceCount objects returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

getDiscoveredResourceCounts_nextToken :: Lens' GetDiscoveredResourceCounts (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getDiscoveredResourceCounts_resourceTypes :: Lens' GetDiscoveredResourceCounts (Maybe [Text]) Source #

The comma-separated list that specifies the resource types that you want Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User").

If a value for resourceTypes is not specified, Config returns all resource types that Config is recording in the region for your account.

If the configuration recorder is turned off, Config returns an empty list of ResourceCount 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 ResourceCount objects.

getDiscoveredResourceCountsResponse_nextToken :: Lens' GetDiscoveredResourceCountsResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

getDiscoveredResourceCountsResponse_resourceCounts :: Lens' GetDiscoveredResourceCountsResponse (Maybe [ResourceCount]) Source #

The list of ResourceCount objects. Each object is listed in descending order by the number of resources.

getDiscoveredResourceCountsResponse_totalDiscoveredResources :: Lens' GetDiscoveredResourceCountsResponse (Maybe Integer) Source #

The total number of resources that Config is recording in the region for your account. If you specify resource types in the request, Config returns only the total number of resources for those resource types.

Example

  1. Config is recording three resource types in the US East (Ohio) Region for your account: 25 EC2 instances, 20 IAM users, and 15 S3 buckets, for a total of 60 resources.
  2. You make a call to the GetDiscoveredResourceCounts action and specify the resource type, "AWS::EC2::Instances", in the request.
  3. Config returns 25 for totalDiscoveredResources.

GetOrganizationConfigRuleDetailedStatus

getOrganizationConfigRuleDetailedStatus_limit :: Lens' GetOrganizationConfigRuleDetailedStatus (Maybe Natural) Source #

The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, Config uses the default. The default is 100.

getOrganizationConfigRuleDetailedStatus_nextToken :: Lens' GetOrganizationConfigRuleDetailedStatus (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getOrganizationConfigRuleDetailedStatus_organizationConfigRuleName :: Lens' GetOrganizationConfigRuleDetailedStatus Text Source #

The name of your organization Config rule for which you want status details for member accounts.

getOrganizationConfigRuleDetailedStatusResponse_nextToken :: Lens' GetOrganizationConfigRuleDetailedStatusResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetOrganizationConformancePackDetailedStatus

getOrganizationConformancePackDetailedStatus_limit :: Lens' GetOrganizationConformancePackDetailedStatus (Maybe Natural) Source #

The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, Config uses the default. The default is 100.

getOrganizationConformancePackDetailedStatus_nextToken :: Lens' GetOrganizationConformancePackDetailedStatus (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getOrganizationConformancePackDetailedStatus_organizationConformancePackName :: Lens' GetOrganizationConformancePackDetailedStatus Text Source #

The name of organization conformance pack for which you want status details for member accounts.

getOrganizationConformancePackDetailedStatusResponse_nextToken :: Lens' GetOrganizationConformancePackDetailedStatusResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

GetOrganizationCustomRulePolicy

getOrganizationCustomRulePolicyResponse_policyText :: Lens' GetOrganizationCustomRulePolicyResponse (Maybe Text) Source #

The policy definition containing the logic for your organization Config Custom Policy rule.

GetResourceConfigHistory

getResourceConfigHistory_chronologicalOrder :: Lens' GetResourceConfigHistory (Maybe ChronologicalOrder) Source #

The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.

getResourceConfigHistory_earlierTime :: Lens' GetResourceConfigHistory (Maybe UTCTime) Source #

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.

getResourceConfigHistory_laterTime :: Lens' GetResourceConfigHistory (Maybe UTCTime) Source #

The time stamp that indicates a later time. If not specified, current time is taken.

getResourceConfigHistory_limit :: Lens' GetResourceConfigHistory (Maybe Natural) Source #

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, Config uses the default.

getResourceConfigHistory_nextToken :: Lens' GetResourceConfigHistory (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

getResourceConfigHistory_resourceId :: Lens' GetResourceConfigHistory Text Source #

The ID of the resource (for example., sg-xxxxxx).

getResourceConfigHistoryResponse_configurationItems :: Lens' GetResourceConfigHistoryResponse (Maybe [ConfigurationItem]) Source #

A list that contains the configuration history of one or more resources.

getResourceConfigHistoryResponse_nextToken :: Lens' GetResourceConfigHistoryResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

GetResourceEvaluationSummary

getResourceEvaluationSummary_resourceEvaluationId :: Lens' GetResourceEvaluationSummary Text Source #

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

getResourceEvaluationSummaryResponse_evaluationMode :: Lens' GetResourceEvaluationSummaryResponse (Maybe EvaluationMode) Source #

Lists results of the mode that you requested to retrieve the resource evaluation summary. The valid values are Detective or Proactive.

getResourceEvaluationSummaryResponse_evaluationStartTimestamp :: Lens' GetResourceEvaluationSummaryResponse (Maybe UTCTime) Source #

The start timestamp when Config rule starts evaluating compliance for the provided resource details.

getResourceEvaluationSummaryResponse_resourceEvaluationId :: Lens' GetResourceEvaluationSummaryResponse (Maybe Text) Source #

The unique ResourceEvaluationId of Amazon Web Services resource execution for which you want to retrieve the evaluation summary.

GetStoredQuery

ListAggregateDiscoveredResources

listAggregateDiscoveredResources_limit :: Lens' ListAggregateDiscoveredResources (Maybe Natural) Source #

The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

listAggregateDiscoveredResources_nextToken :: Lens' ListAggregateDiscoveredResources (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

listAggregateDiscoveredResources_resourceType :: Lens' ListAggregateDiscoveredResources ResourceType Source #

The type of resources that you want Config to list in the response.

listAggregateDiscoveredResourcesResponse_nextToken :: Lens' ListAggregateDiscoveredResourcesResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ListConformancePackComplianceScores

listConformancePackComplianceScores_limit :: Lens' ListConformancePackComplianceScores (Maybe Natural) Source #

The maximum number of conformance pack compliance scores returned on each page.

listConformancePackComplianceScores_nextToken :: Lens' ListConformancePackComplianceScores (Maybe Text) Source #

The nextToken string in a prior request that you can use to get the paginated response for next set of conformance pack compliance scores.

listConformancePackComplianceScores_sortBy :: Lens' ListConformancePackComplianceScores (Maybe SortBy) Source #

Sorts your conformance pack compliance scores in either ascending or descending order, depending on SortOrder.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Enter SCORE, to sort conformance pack compliance scores by the numerical value of the compliance score.

listConformancePackComplianceScores_sortOrder :: Lens' ListConformancePackComplianceScores (Maybe SortOrder) Source #

Determines the order in which conformance pack compliance scores are sorted. Either in ascending or descending order.

By default, conformance pack compliance scores are sorted in alphabetical order by name of the conformance pack. Conformance pack compliance scores are sorted in reverse alphabetical order if you enter DESCENDING.

You can sort conformance pack compliance scores by the numerical value of the compliance score by entering SCORE in the SortBy action. When compliance scores are sorted by SCORE, conformance packs with a compliance score of INSUFFICIENT_DATA will be last when sorting by ascending order and first when sorting by descending order.

listConformancePackComplianceScoresResponse_nextToken :: Lens' ListConformancePackComplianceScoresResponse (Maybe Text) Source #

The nextToken string that you can use to get the next page of results in a paginated response.

ListDiscoveredResources

listDiscoveredResources_includeDeletedResources :: Lens' ListDiscoveredResources (Maybe Bool) Source #

Specifies whether Config includes deleted resources in the results. By default, deleted resources are not included.

listDiscoveredResources_limit :: Lens' ListDiscoveredResources (Maybe Natural) Source #

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, Config uses the default.

listDiscoveredResources_nextToken :: Lens' ListDiscoveredResources (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

listDiscoveredResources_resourceIds :: Lens' ListDiscoveredResources (Maybe [Text]) Source #

The IDs of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

listDiscoveredResources_resourceName :: Lens' ListDiscoveredResources (Maybe Text) Source #

The custom name of only those resources that you want Config to list in the response. If you do not specify this parameter, Config lists all resources of the specified type that it has discovered.

listDiscoveredResources_resourceType :: Lens' ListDiscoveredResources ResourceType Source #

The type of resources that you want Config to list in the response.

listDiscoveredResourcesResponse_nextToken :: Lens' ListDiscoveredResourcesResponse (Maybe Text) Source #

The string that you use in a subsequent request to get the next page of results in a paginated response.

listDiscoveredResourcesResponse_resourceIdentifiers :: Lens' ListDiscoveredResourcesResponse (Maybe [ResourceIdentifier]) Source #

The details that identify a resource that is discovered by Config, including the resource type, ID, and (if available) the custom resource name.

ListResourceEvaluations

listResourceEvaluations_limit :: Lens' ListResourceEvaluations (Maybe Natural) Source #

The maximum number of evaluations returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, Config uses the default.

listResourceEvaluations_nextToken :: Lens' ListResourceEvaluations (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

listResourceEvaluationsResponse_nextToken :: Lens' ListResourceEvaluationsResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

ListStoredQueries

listStoredQueries_maxResults :: Lens' ListStoredQueries (Maybe Natural) Source #

The maximum number of results to be returned with a single call.

listStoredQueries_nextToken :: Lens' ListStoredQueries (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

listStoredQueriesResponse_nextToken :: Lens' ListStoredQueriesResponse (Maybe Text) Source #

If the previous paginated request didn't return all of the remaining results, the response object's NextToken parameter value is set to a token. To retrieve the next set of results, call this action again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

ListTagsForResource

listTagsForResource_limit :: Lens' ListTagsForResource (Maybe Natural) Source #

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, Config uses the default.

listTagsForResource_nextToken :: Lens' ListTagsForResource (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

listTagsForResourceResponse_nextToken :: Lens' ListTagsForResourceResponse (Maybe Text) Source #

The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.

PutAggregationAuthorization

putAggregationAuthorization_authorizedAccountId :: Lens' PutAggregationAuthorization Text Source #

The 12-digit account ID of the account authorized to aggregate data.

PutConfigRule

putConfigRule_tags :: Lens' PutConfigRule (Maybe [Tag]) Source #

An array of tag object.

putConfigRule_configRule :: Lens' PutConfigRule ConfigRule Source #

The rule that you want to add to your account.

PutConfigurationAggregator

PutConfigurationRecorder

putConfigurationRecorder_configurationRecorder :: Lens' PutConfigurationRecorder ConfigurationRecorder Source #

The configuration recorder object that records each configuration change made to the resources.

PutConformancePack

putConformancePack_deliveryS3Bucket :: Lens' PutConformancePack (Maybe Text) Source #

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

putConformancePack_deliveryS3KeyPrefix :: Lens' PutConformancePack (Maybe Text) Source #

The prefix for the Amazon S3 bucket.

This field is optional.

putConformancePack_templateBody :: Lens' PutConformancePack (Maybe Text) Source #

A string containing the full conformance pack template body. The structure containing the template body has a minimum length of 1 byte and a maximum length of 51,200 bytes.

You can use a YAML template with two resource types: Config rule (AWS::Config::ConfigRule) and remediation action (AWS::Config::RemediationConfiguration).

putConformancePack_templateS3Uri :: Lens' PutConformancePack (Maybe Text) Source #

The location of the file containing the template body (s3://bucketname/prefix). The uri must point to a conformance pack template (max size: 300 KB) that is located in an Amazon S3 bucket in the same Region as the conformance pack.

You must have access to read Amazon S3 bucket.

putConformancePack_templateSSMDocumentDetails :: Lens' PutConformancePack (Maybe TemplateSSMDocumentDetails) Source #

An object of type TemplateSSMDocumentDetails, which contains the name or the Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

putConformancePack_conformancePackName :: Lens' PutConformancePack Text Source #

The unique name of the conformance pack you want to deploy.

PutDeliveryChannel

putDeliveryChannel_deliveryChannel :: Lens' PutDeliveryChannel DeliveryChannel Source #

The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.

PutEvaluations

putEvaluations_evaluations :: Lens' PutEvaluations (Maybe [Evaluation]) Source #

The assessments that the Lambda function performs. Each evaluation identifies an Amazon Web Services resource and indicates whether it complies with the Config rule that invokes the Lambda function.

putEvaluations_testMode :: Lens' PutEvaluations (Maybe Bool) Source #

Use this parameter to specify a test run for PutEvaluations. You can verify whether your Lambda function will deliver evaluation results to Config. No updates occur to your existing evaluations, and evaluation results are not sent to Config.

When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.

putEvaluations_resultToken :: Lens' PutEvaluations Text Source #

An encrypted token that associates an evaluation with an Config rule. Identifies the rule and the event that triggered the evaluation.

putEvaluationsResponse_failedEvaluations :: Lens' PutEvaluationsResponse (Maybe [Evaluation]) Source #

Requests that failed because of a client or server error.

PutExternalEvaluation

putExternalEvaluation_externalEvaluation :: Lens' PutExternalEvaluation ExternalEvaluation Source #

An ExternalEvaluation object that provides details about compliance.

PutOrganizationConfigRule

putOrganizationConfigRule_excludedAccounts :: Lens' PutOrganizationConfigRule (Maybe [Text]) Source #

A comma-separated list of accounts that you want to exclude from an organization Config rule.

putOrganizationConfigRule_organizationCustomPolicyRuleMetadata :: Lens' PutOrganizationConfigRule (Maybe OrganizationCustomPolicyRuleMetadata) Source #

An OrganizationCustomPolicyRuleMetadata object. This object specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

putOrganizationConfigRule_organizationCustomRuleMetadata :: Lens' PutOrganizationConfigRule (Maybe OrganizationCustomRuleMetadata) Source #

An OrganizationCustomRuleMetadata object. This object specifies organization custom rule metadata such as resource type, resource ID of Amazon Web Services resource, Lambda function ARN, and organization trigger types that trigger Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

putOrganizationConfigRule_organizationManagedRuleMetadata :: Lens' PutOrganizationConfigRule (Maybe OrganizationManagedRuleMetadata) Source #

An OrganizationManagedRuleMetadata object. This object specifies organization managed rule metadata such as resource type and ID of Amazon Web Services resource along with the rule identifier. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

putOrganizationConfigRule_organizationConfigRuleName :: Lens' PutOrganizationConfigRule Text Source #

The name that you assign to an organization Config rule.

PutOrganizationConformancePack

putOrganizationConformancePack_deliveryS3Bucket :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional. If used, it must be prefixed with awsconfigconforms.

putOrganizationConformancePack_deliveryS3KeyPrefix :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

The prefix for the Amazon S3 bucket.

This field is optional.

putOrganizationConformancePack_excludedAccounts :: Lens' PutOrganizationConformancePack (Maybe [Text]) Source #

A list of Amazon Web Services accounts to be excluded from an organization conformance pack while deploying a conformance pack.

putOrganizationConformancePack_templateBody :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

A string containing full conformance pack template body. Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.

putOrganizationConformancePack_templateS3Uri :: Lens' PutOrganizationConformancePack (Maybe Text) Source #

Location of file containing the template body. The uri must point to the conformance pack template (max size: 300 KB).

You must have access to read Amazon S3 bucket.

PutRemediationConfigurations

PutRemediationExceptions

putRemediationExceptions_expirationTime :: Lens' PutRemediationExceptions (Maybe UTCTime) Source #

The exception is automatically deleted after the expiration date.

putRemediationExceptions_message :: Lens' PutRemediationExceptions (Maybe Text) Source #

The message contains an explanation of the exception.

putRemediationExceptions_configRuleName :: Lens' PutRemediationExceptions Text Source #

The name of the Config rule for which you want to create remediation exception.

putRemediationExceptions_resourceKeys :: Lens' PutRemediationExceptions (NonEmpty RemediationExceptionResourceKey) Source #

An exception list of resource exception keys to be processed with the current request. Config adds exception for each resource key. For example, Config adds 3 exceptions for 3 resource keys.

putRemediationExceptionsResponse_failedBatches :: Lens' PutRemediationExceptionsResponse (Maybe [FailedRemediationExceptionBatch]) Source #

Returns a list of failed remediation exceptions batch objects. Each object in the batch consists of a list of failed items and failure messages.

PutResourceConfig

putResourceConfig_tags :: Lens' PutResourceConfig (Maybe (HashMap Text Text)) Source #

Tags associated with the resource.

This field is not to be confused with the Amazon Web Services-wide tag feature for Amazon Web Services resources. Tags for PutResourceConfig are tags that you supply for the configuration items of your custom resources.

putResourceConfig_resourceType :: Lens' PutResourceConfig Text Source #

The type of the resource. The custom resource type must be registered with CloudFormation.

You cannot use the organization names “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.

putResourceConfig_schemaVersionId :: Lens' PutResourceConfig Text Source #

Version of the schema registered for the ResourceType in CloudFormation.

putResourceConfig_resourceId :: Lens' PutResourceConfig Text Source #

Unique identifier of the resource.

putResourceConfig_configuration :: Lens' PutResourceConfig Text Source #

The configuration object of the resource in valid JSON format. It must match the schema registered with CloudFormation.

The configuration JSON must not exceed 64 KB.

PutRetentionConfiguration

putRetentionConfiguration_retentionPeriodInDays :: Lens' PutRetentionConfiguration Natural Source #

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

PutStoredQuery

putStoredQuery_storedQuery :: Lens' PutStoredQuery StoredQuery Source #

A list of StoredQuery objects. The mandatory fields are QueryName and Expression.

When you are creating a query, you must provide a query name and an expression. When you are updating a query, you must provide a query name but updating the description is optional.

putStoredQueryResponse_queryArn :: Lens' PutStoredQueryResponse (Maybe Text) Source #

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

SelectAggregateResourceConfig

selectAggregateResourceConfig_limit :: Lens' SelectAggregateResourceConfig (Maybe Natural) Source #

The maximum number of query results returned on each page.

selectAggregateResourceConfig_maxResults :: Lens' SelectAggregateResourceConfig (Maybe Natural) Source #

The maximum number of query results returned on each page. Config also allows the Limit request parameter.

selectAggregateResourceConfig_nextToken :: Lens' SelectAggregateResourceConfig (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

selectAggregateResourceConfigResponse_nextToken :: Lens' SelectAggregateResourceConfigResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

SelectResourceConfig

selectResourceConfig_limit :: Lens' SelectResourceConfig (Maybe Natural) Source #

The maximum number of query results returned on each page.

selectResourceConfig_nextToken :: Lens' SelectResourceConfig (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

selectResourceConfigResponse_nextToken :: Lens' SelectResourceConfigResponse (Maybe Text) Source #

The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.

StartConfigRulesEvaluation

startConfigRulesEvaluation_configRuleNames :: Lens' StartConfigRulesEvaluation (Maybe (NonEmpty Text)) Source #

The list of names of Config rules that you want to run evaluations for.

StartConfigurationRecorder

startConfigurationRecorder_configurationRecorderName :: Lens' StartConfigurationRecorder Text Source #

The name of the recorder object that records each configuration change made to the resources.

StartRemediationExecution

startRemediationExecution_configRuleName :: Lens' StartRemediationExecution Text Source #

The list of names of Config rules that you want to run remediation execution for.

startRemediationExecution_resourceKeys :: Lens' StartRemediationExecution (NonEmpty ResourceKey) Source #

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.

startRemediationExecutionResponse_failedItems :: Lens' StartRemediationExecutionResponse (Maybe (NonEmpty ResourceKey)) Source #

For resources that have failed to start execution, the API returns a resource key object.

startRemediationExecutionResponse_failureMessage :: Lens' StartRemediationExecutionResponse (Maybe Text) Source #

Returns a failure message. For example, the resource is already compliant.

StartResourceEvaluation

startResourceEvaluation_clientToken :: Lens' StartResourceEvaluation (Maybe Text) Source #

A client token is a unique, case-sensitive string of up to 64 ASCII characters. To make an idempotent API request using one of these actions, specify a client token in the request.

Avoid reusing the same client token for other API requests. If you retry a request that completed successfully using the same client token and the same parameters, the retry succeeds without performing any further actions. If you retry a successful request using the same client token, but one or more of the parameters are different, other than the Region or Availability Zone, the retry fails with an IdempotentParameterMismatch error.

startResourceEvaluation_evaluationTimeout :: Lens' StartResourceEvaluation (Maybe Natural) Source #

The timeout for an evaluation. The default is 900 seconds. You cannot specify a number greater than 3600. If you specify 0, Config uses the default.

startResourceEvaluation_evaluationMode :: Lens' StartResourceEvaluation EvaluationMode Source #

The mode of an evaluation. The valid value for this API is Proactive.

startResourceEvaluationResponse_resourceEvaluationId :: Lens' StartResourceEvaluationResponse (Maybe Text) Source #

A unique ResourceEvaluationId that is associated with a single execution.

StopConfigurationRecorder

stopConfigurationRecorder_configurationRecorderName :: Lens' StopConfigurationRecorder Text Source #

The name of the recorder object that records each configuration change made to the resources.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

tagResource_tags :: Lens' TagResource (NonEmpty Tag) Source #

An array of tag object.

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.

untagResource_tagKeys :: Lens' UntagResource (NonEmpty Text) Source #

The keys of the tags to be removed.

Types

AccountAggregationSource

accountAggregationSource_allAwsRegions :: Lens' AccountAggregationSource (Maybe Bool) Source #

If true, aggregate existing Config regions and future regions.

accountAggregationSource_accountIds :: Lens' AccountAggregationSource (NonEmpty Text) Source #

The 12-digit account ID of the account being aggregated.

AggregateComplianceByConfigRule

aggregateComplianceByConfigRule_awsRegion :: Lens' AggregateComplianceByConfigRule (Maybe Text) Source #

The source region from where the data is aggregated.

aggregateComplianceByConfigRule_compliance :: Lens' AggregateComplianceByConfigRule (Maybe Compliance) Source #

Indicates whether an Amazon Web Services resource or Config rule is compliant and provides the number of contributors that affect the compliance.

AggregateComplianceByConformancePack

aggregateComplianceByConformancePack_accountId :: Lens' AggregateComplianceByConformancePack (Maybe Text) Source #

The 12-digit Amazon Web Services account ID of the source account.

aggregateComplianceByConformancePack_awsRegion :: Lens' AggregateComplianceByConformancePack (Maybe Text) Source #

The source Amazon Web Services Region from where the data is aggregated.

AggregateComplianceCount

aggregateComplianceCount_groupName :: Lens' AggregateComplianceCount (Maybe Text) Source #

The 12-digit account ID or region based on the GroupByKey value.

AggregateConformancePackCompliance

aggregateConformancePackCompliance_totalRuleCount :: Lens' AggregateConformancePackCompliance (Maybe Int) Source #

Total number of compliant rules, noncompliant rules, and the rules that do not have any applicable resources to evaluate upon resulting in insufficient data.

AggregateConformancePackComplianceCount

AggregateConformancePackComplianceFilters

aggregateConformancePackComplianceFilters_accountId :: Lens' AggregateConformancePackComplianceFilters (Maybe Text) Source #

The 12-digit Amazon Web Services account ID of the source account.

aggregateConformancePackComplianceFilters_awsRegion :: Lens' AggregateConformancePackComplianceFilters (Maybe Text) Source #

The source Amazon Web Services Region from where the data is aggregated.

AggregateConformancePackComplianceSummary

aggregateConformancePackComplianceSummary_groupName :: Lens' AggregateConformancePackComplianceSummary (Maybe Text) Source #

Groups the result based on Amazon Web Services account ID or Amazon Web Services Region.

AggregateConformancePackComplianceSummaryFilters

AggregateEvaluationResult

aggregateEvaluationResult_accountId :: Lens' AggregateEvaluationResult (Maybe Text) Source #

The 12-digit account ID of the source account.

aggregateEvaluationResult_annotation :: Lens' AggregateEvaluationResult (Maybe Text) Source #

Supplementary information about how the agrregate evaluation determined the compliance.

aggregateEvaluationResult_awsRegion :: Lens' AggregateEvaluationResult (Maybe Text) Source #

The source region from where the data is aggregated.

aggregateEvaluationResult_complianceType :: Lens' AggregateEvaluationResult (Maybe ComplianceType) Source #

The resource compliance status.

For the AggregationEvaluationResult data type, Config supports only the COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and INSUFFICIENT_DATA value.

aggregateEvaluationResult_configRuleInvokedTime :: Lens' AggregateEvaluationResult (Maybe UTCTime) Source #

The time when the Config rule evaluated the Amazon Web Services resource.

aggregateEvaluationResult_resultRecordedTime :: Lens' AggregateEvaluationResult (Maybe UTCTime) Source #

The time when Config recorded the aggregate evaluation result.

AggregateResourceIdentifier

AggregatedSourceStatus

aggregatedSourceStatus_awsRegion :: Lens' AggregatedSourceStatus (Maybe Text) Source #

The region authorized to collect aggregated data.

aggregatedSourceStatus_lastErrorCode :: Lens' AggregatedSourceStatus (Maybe Text) Source #

The error code that Config returned when the source account aggregation last failed.

aggregatedSourceStatus_lastErrorMessage :: Lens' AggregatedSourceStatus (Maybe Text) Source #

The message indicating that the source account aggregation failed due to an error.

aggregatedSourceStatus_lastUpdateStatus :: Lens' AggregatedSourceStatus (Maybe AggregatedSourceStatusType) Source #

Filters the last updated status type.

  • Valid value FAILED indicates errors while moving data.
  • Valid value SUCCEEDED indicates the data was successfully moved.
  • Valid value OUTDATED indicates the data is not the most recent.

aggregatedSourceStatus_sourceId :: Lens' AggregatedSourceStatus (Maybe Text) Source #

The source account ID or an organization.

AggregationAuthorization

aggregationAuthorization_aggregationAuthorizationArn :: Lens' AggregationAuthorization (Maybe Text) Source #

The Amazon Resource Name (ARN) of the aggregation object.

aggregationAuthorization_authorizedAccountId :: Lens' AggregationAuthorization (Maybe Text) Source #

The 12-digit account ID of the account authorized to aggregate data.

aggregationAuthorization_authorizedAwsRegion :: Lens' AggregationAuthorization (Maybe Text) Source #

The region authorized to collect aggregated data.

aggregationAuthorization_creationTime :: Lens' AggregationAuthorization (Maybe UTCTime) Source #

The time stamp when the aggregation authorization was created.

BaseConfigurationItem

baseConfigurationItem_accountId :: Lens' BaseConfigurationItem (Maybe Text) Source #

The 12-digit Amazon Web Services account ID associated with the resource.

baseConfigurationItem_arn :: Lens' BaseConfigurationItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the resource.

baseConfigurationItem_availabilityZone :: Lens' BaseConfigurationItem (Maybe Text) Source #

The Availability Zone associated with the resource.

baseConfigurationItem_awsRegion :: Lens' BaseConfigurationItem (Maybe Text) Source #

The region where the resource resides.

baseConfigurationItem_configuration :: Lens' BaseConfigurationItem (Maybe Text) Source #

The description of the resource configuration.

baseConfigurationItem_configurationItemCaptureTime :: Lens' BaseConfigurationItem (Maybe UTCTime) Source #

The time when the configuration recording was initiated.

baseConfigurationItem_configurationItemStatus :: Lens' BaseConfigurationItem (Maybe ConfigurationItemStatus) Source #

The configuration item status. The valid values are:

  • OK – The resource configuration has been updated
  • ResourceDiscovered – The resource was newly discovered
  • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
  • ResourceDeleted – The resource was deleted
  • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

baseConfigurationItem_configurationStateId :: Lens' BaseConfigurationItem (Maybe Text) Source #

An identifier that indicates the ordering of the configuration items of a resource.

baseConfigurationItem_resourceId :: Lens' BaseConfigurationItem (Maybe Text) Source #

The ID of the resource (for example., sg-xxxxxx).

baseConfigurationItem_resourceName :: Lens' BaseConfigurationItem (Maybe Text) Source #

The custom name of the resource, if available.

baseConfigurationItem_supplementaryConfiguration :: Lens' BaseConfigurationItem (Maybe (HashMap Text Text)) Source #

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

baseConfigurationItem_version :: Lens' BaseConfigurationItem (Maybe Text) Source #

The version number of the resource configuration.

Compliance

compliance_complianceContributorCount :: Lens' Compliance (Maybe ComplianceContributorCount) Source #

The number of Amazon Web Services resources or Config rules that cause a result of NON_COMPLIANT, up to a maximum number.

compliance_complianceType :: Lens' Compliance (Maybe ComplianceType) Source #

Indicates whether an Amazon Web Services resource or Config rule is compliant.

A resource is compliant if it complies with all of the Config rules that evaluate it. A resource is noncompliant if it does not comply with one or more of these rules.

A rule is compliant if all of the resources that the rule evaluates comply with it. A rule is noncompliant if any of these resources do not comply.

Config returns the INSUFFICIENT_DATA value when no evaluation results are available for the Amazon Web Services resource or Config rule.

For the Compliance data type, Config supports only COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA values. Config does not support the NOT_APPLICABLE value for the Compliance data type.

ComplianceByConfigRule

complianceByConfigRule_compliance :: Lens' ComplianceByConfigRule (Maybe Compliance) Source #

Indicates whether the Config rule is compliant.

ComplianceByResource

complianceByResource_compliance :: Lens' ComplianceByResource (Maybe Compliance) Source #

Indicates whether the Amazon Web Services resource complies with all of the Config rules that evaluated it.

complianceByResource_resourceId :: Lens' ComplianceByResource (Maybe Text) Source #

The ID of the Amazon Web Services resource that was evaluated.

complianceByResource_resourceType :: Lens' ComplianceByResource (Maybe Text) Source #

The type of the Amazon Web Services resource that was evaluated.

ComplianceContributorCount

complianceContributorCount_capExceeded :: Lens' ComplianceContributorCount (Maybe Bool) Source #

Indicates whether the maximum count is reached.

complianceContributorCount_cappedCount :: Lens' ComplianceContributorCount (Maybe Int) Source #

The number of Amazon Web Services resources or Config rules responsible for the current compliance of the item.

ComplianceSummary

complianceSummary_complianceSummaryTimestamp :: Lens' ComplianceSummary (Maybe UTCTime) Source #

The time that Config created the compliance summary.

complianceSummary_compliantResourceCount :: Lens' ComplianceSummary (Maybe ComplianceContributorCount) Source #

The number of Config rules or Amazon Web Services resources that are compliant, up to a maximum of 25 for rules and 100 for resources.

complianceSummary_nonCompliantResourceCount :: Lens' ComplianceSummary (Maybe ComplianceContributorCount) Source #

The number of Config rules or Amazon Web Services resources that are noncompliant, up to a maximum of 25 for rules and 100 for resources.

ComplianceSummaryByResourceType

complianceSummaryByResourceType_complianceSummary :: Lens' ComplianceSummaryByResourceType (Maybe ComplianceSummary) Source #

The number of Amazon Web Services resources that are compliant or noncompliant, up to a maximum of 100 for each.

ConfigExportDeliveryInfo

configExportDeliveryInfo_lastErrorCode :: Lens' ConfigExportDeliveryInfo (Maybe Text) Source #

The error code from the last attempted delivery.

configExportDeliveryInfo_lastErrorMessage :: Lens' ConfigExportDeliveryInfo (Maybe Text) Source #

The error message from the last attempted delivery.

ConfigRule

configRule_configRuleArn :: Lens' ConfigRule (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Config rule.

configRule_configRuleId :: Lens' ConfigRule (Maybe Text) Source #

The ID of the Config rule.

configRule_configRuleName :: Lens' ConfigRule (Maybe Text) Source #

The name that you assign to the Config rule. The name is required if you are adding a new rule.

configRule_configRuleState :: Lens' ConfigRule (Maybe ConfigRuleState) Source #

Indicates whether the Config rule is active or is currently being deleted by Config. It can also indicate the evaluation status for the Config rule.

Config sets the state of the rule to EVALUATING temporarily after you use the StartConfigRulesEvaluation request to evaluate your resources against the Config rule.

Config sets the state of the rule to DELETING_RESULTS temporarily after you use the DeleteEvaluationResults request to delete the current evaluation results for the Config rule.

Config temporarily sets the state of a rule to DELETING after you use the DeleteConfigRule request to delete the rule. After Config deletes the rule, the rule and all of its evaluations are erased and are no longer available.

configRule_createdBy :: Lens' ConfigRule (Maybe Text) Source #

Service principal name of the service that created the rule.

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.

configRule_description :: Lens' ConfigRule (Maybe Text) Source #

The description that you provide for the Config rule.

configRule_evaluationModes :: Lens' ConfigRule (Maybe [EvaluationModeConfiguration]) Source #

The modes the Config rule can be evaluated in. The valid values are distinct objects. By default, the value is Detective evaluation mode only.

configRule_inputParameters :: Lens' ConfigRule (Maybe Text) Source #

A string, in JSON format, that is passed to the Config rule Lambda function.

configRule_maximumExecutionFrequency :: Lens' ConfigRule (Maybe MaximumExecutionFrequency) Source #

The maximum frequency with which Config runs evaluations for a rule. You can specify a value for MaximumExecutionFrequency when:

  • This is for an Config managed rule that is triggered at a periodic frequency.
  • Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

configRule_scope :: Lens' ConfigRule (Maybe Scope) Source #

Defines which resources can trigger an evaluation for the rule. The scope can include one or more resource types, a combination of one resource type and one resource ID, or a combination of a tag key and value. Specify a scope to constrain the resources that can trigger an evaluation for the rule. If you do not specify a scope, evaluations are triggered when any resource in the recording group changes.

The scope can be empty.

configRule_source :: Lens' ConfigRule Source Source #

Provides the rule owner (Amazon Web Services for managed rules, CUSTOM_POLICY for Custom Policy rules, and CUSTOM_LAMBDA for Custom Lambda rules), the rule identifier, and the notifications that cause the function to evaluate your Amazon Web Services resources.

ConfigRuleComplianceFilters

configRuleComplianceFilters_accountId :: Lens' ConfigRuleComplianceFilters (Maybe Text) Source #

The 12-digit account ID of the source account.

configRuleComplianceFilters_awsRegion :: Lens' ConfigRuleComplianceFilters (Maybe Text) Source #

The source region where the data is aggregated.

configRuleComplianceFilters_complianceType :: Lens' ConfigRuleComplianceFilters (Maybe ComplianceType) Source #

The rule compliance status.

For the ConfigRuleComplianceFilters data type, Config supports only COMPLIANT and NON_COMPLIANT. Config does not support the NOT_APPLICABLE and the INSUFFICIENT_DATA values.

ConfigRuleComplianceSummaryFilters

ConfigRuleEvaluationStatus

configRuleEvaluationStatus_configRuleArn :: Lens' ConfigRuleEvaluationStatus (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Config rule.

configRuleEvaluationStatus_firstEvaluationStarted :: Lens' ConfigRuleEvaluationStatus (Maybe Bool) Source #

Indicates whether Config has evaluated your resources against the rule at least once.

  • true - Config has evaluated your Amazon Web Services resources against the rule at least once.
  • false - Config has not finished evaluating your Amazon Web Services resources against the rule at least once.

configRuleEvaluationStatus_lastDebugLogDeliveryStatus :: Lens' ConfigRuleEvaluationStatus (Maybe Text) Source #

The status of the last attempted delivery of a debug log for your Config Custom Policy rules. Either Successful or Failed.

configRuleEvaluationStatus_lastDebugLogDeliveryStatusReason :: Lens' ConfigRuleEvaluationStatus (Maybe Text) Source #

The reason Config was not able to deliver a debug log. This is for the last failed attempt to retrieve a debug log for your Config Custom Policy rules.

configRuleEvaluationStatus_lastDebugLogDeliveryTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime) Source #

The time Config last attempted to deliver a debug log for your Config Custom Policy rules.

configRuleEvaluationStatus_lastErrorCode :: Lens' ConfigRuleEvaluationStatus (Maybe Text) Source #

The error code that Config returned when the rule last failed.

configRuleEvaluationStatus_lastErrorMessage :: Lens' ConfigRuleEvaluationStatus (Maybe Text) Source #

The error message that Config returned when the rule last failed.

configRuleEvaluationStatus_lastFailedEvaluationTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime) Source #

The time that Config last failed to evaluate your Amazon Web Services resources against the rule.

configRuleEvaluationStatus_lastFailedInvocationTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime) Source #

The time that Config last failed to invoke the Config rule to evaluate your Amazon Web Services resources.

configRuleEvaluationStatus_lastSuccessfulEvaluationTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime) Source #

The time that Config last successfully evaluated your Amazon Web Services resources against the rule.

configRuleEvaluationStatus_lastSuccessfulInvocationTime :: Lens' ConfigRuleEvaluationStatus (Maybe UTCTime) Source #

The time that Config last successfully invoked the Config rule to evaluate your Amazon Web Services resources.

ConfigSnapshotDeliveryProperties

ConfigStreamDeliveryInfo

configStreamDeliveryInfo_lastErrorCode :: Lens' ConfigStreamDeliveryInfo (Maybe Text) Source #

The error code from the last attempted delivery.

configStreamDeliveryInfo_lastErrorMessage :: Lens' ConfigStreamDeliveryInfo (Maybe Text) Source #

The error message from the last attempted delivery.

configStreamDeliveryInfo_lastStatus :: Lens' ConfigStreamDeliveryInfo (Maybe DeliveryStatus) Source #

Status of the last attempted delivery.

Note Providing an SNS topic on a DeliveryChannel for Config is optional. If the SNS delivery is turned off, the last status will be Not_Applicable.

ConfigurationAggregator

configurationAggregator_accountAggregationSources :: Lens' ConfigurationAggregator (Maybe [AccountAggregationSource]) Source #

Provides a list of source accounts and regions to be aggregated.

configurationAggregator_createdBy :: Lens' ConfigurationAggregator (Maybe Text) Source #

Amazon Web Services service that created the configuration aggregator.

configurationAggregator_creationTime :: Lens' ConfigurationAggregator (Maybe UTCTime) Source #

The time stamp when the configuration aggregator was created.

ConfigurationItem

configurationItem_accountId :: Lens' ConfigurationItem (Maybe Text) Source #

The 12-digit Amazon Web Services account ID associated with the resource.

configurationItem_arn :: Lens' ConfigurationItem (Maybe Text) Source #

Amazon Resource Name (ARN) associated with the resource.

configurationItem_availabilityZone :: Lens' ConfigurationItem (Maybe Text) Source #

The Availability Zone associated with the resource.

configurationItem_awsRegion :: Lens' ConfigurationItem (Maybe Text) Source #

The region where the resource resides.

configurationItem_configuration :: Lens' ConfigurationItem (Maybe Text) Source #

The description of the resource configuration.

configurationItem_configurationItemCaptureTime :: Lens' ConfigurationItem (Maybe UTCTime) Source #

The time when the configuration recording was initiated.

configurationItem_configurationItemMD5Hash :: Lens' ConfigurationItem (Maybe Text) Source #

Unique MD5 hash that represents the configuration item's state.

You can use MD5 hash to compare the states of two or more configuration items that are associated with the same resource.

configurationItem_configurationItemStatus :: Lens' ConfigurationItem (Maybe ConfigurationItemStatus) Source #

The configuration item status. The valid values are:

  • OK – The resource configuration has been updated
  • ResourceDiscovered – The resource was newly discovered
  • ResourceNotRecorded – The resource was discovered but its configuration was not recorded since the recorder excludes the recording of resources of this type
  • ResourceDeleted – The resource was deleted
  • ResourceDeletedNotRecorded – The resource was deleted but its configuration was not recorded since the recorder excludes the recording of resources of this type

The CIs do not incur any cost.

configurationItem_configurationStateId :: Lens' ConfigurationItem (Maybe Text) Source #

An identifier that indicates the ordering of the configuration items of a resource.

configurationItem_relatedEvents :: Lens' ConfigurationItem (Maybe [Text]) Source #

A list of CloudTrail event IDs.

A populated field indicates that the current configuration was initiated by the events recorded in the CloudTrail log. For more information about CloudTrail, see What Is CloudTrail.

An empty field indicates that the current configuration was not initiated by any event. As of Version 1.3, the relatedEvents field is empty. You can access the LookupEvents API in the CloudTrail API Reference to retrieve the events for the resource.

configurationItem_relationships :: Lens' ConfigurationItem (Maybe [Relationship]) Source #

A list of related Amazon Web Services resources.

configurationItem_resourceCreationTime :: Lens' ConfigurationItem (Maybe UTCTime) Source #

The time stamp when the resource was created.

configurationItem_resourceId :: Lens' ConfigurationItem (Maybe Text) Source #

The ID of the resource (for example, sg-xxxxxx).

configurationItem_resourceName :: Lens' ConfigurationItem (Maybe Text) Source #

The custom name of the resource, if available.

configurationItem_resourceType :: Lens' ConfigurationItem (Maybe ResourceType) Source #

The type of Amazon Web Services resource.

configurationItem_supplementaryConfiguration :: Lens' ConfigurationItem (Maybe (HashMap Text Text)) Source #

Configuration attributes that Config returns for certain resource types to supplement the information returned for the configuration parameter.

configurationItem_tags :: Lens' ConfigurationItem (Maybe (HashMap Text Text)) Source #

A mapping of key value tags associated with the resource.

configurationItem_version :: Lens' ConfigurationItem (Maybe Text) Source #

The version number of the resource configuration.

ConfigurationRecorder

configurationRecorder_name :: Lens' ConfigurationRecorder (Maybe Text) Source #

The name of the recorder. By default, Config automatically assigns the name "default" when creating the configuration recorder. You cannot change the assigned name.

configurationRecorder_recordingGroup :: Lens' ConfigurationRecorder (Maybe RecordingGroup) Source #

Specifies the types of Amazon Web Services resources for which Config records configuration changes.

configurationRecorder_roleARN :: Lens' ConfigurationRecorder (Maybe Text) Source #

Amazon Resource Name (ARN) of the IAM role used to describe the Amazon Web Services resources associated with the account.

While the API model does not require this field, the server will reject a request without a defined roleARN for the configuration recorder.

ConfigurationRecorderStatus

configurationRecorderStatus_lastErrorCode :: Lens' ConfigurationRecorderStatus (Maybe Text) Source #

The error code indicating that the recording failed.

configurationRecorderStatus_lastErrorMessage :: Lens' ConfigurationRecorderStatus (Maybe Text) Source #

The message indicating that the recording failed due to an error.

configurationRecorderStatus_recording :: Lens' ConfigurationRecorderStatus (Maybe Bool) Source #

Specifies whether or not the recorder is currently recording.

ConformancePackComplianceFilters

conformancePackComplianceFilters_complianceType :: Lens' ConformancePackComplianceFilters (Maybe ConformancePackComplianceType) Source #

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

ConformancePackComplianceScore

conformancePackComplianceScore_lastUpdatedTime :: Lens' ConformancePackComplianceScore (Maybe UTCTime) Source #

The time that the conformance pack compliance score was last updated.

conformancePackComplianceScore_score :: Lens' ConformancePackComplianceScore (Maybe Text) Source #

Compliance score for the conformance pack. Conformance packs with no evaluation results will have a compliance score of INSUFFICIENT_DATA.

ConformancePackComplianceScoresFilters

conformancePackComplianceScoresFilters_conformancePackNames :: Lens' ConformancePackComplianceScoresFilters (NonEmpty Text) Source #

The names of the conformance packs whose compliance scores you want to include in the conformance pack compliance score result set. You can include up to 25 conformance packs in the ConformancePackNames array of strings, each with a character limit of 256 characters for the conformance pack name.

ConformancePackComplianceSummary

conformancePackComplianceSummary_conformancePackComplianceStatus :: Lens' ConformancePackComplianceSummary ConformancePackComplianceType Source #

The status of the conformance pack. The allowed values are COMPLIANT, NON_COMPLIANT and INSUFFICIENT_DATA.

ConformancePackDetail

conformancePackDetail_createdBy :: Lens' ConformancePackDetail (Maybe Text) Source #

The Amazon Web Services service that created the conformance pack.

conformancePackDetail_deliveryS3Bucket :: Lens' ConformancePackDetail (Maybe Text) Source #

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

conformancePackDetail_deliveryS3KeyPrefix :: Lens' ConformancePackDetail (Maybe Text) Source #

The prefix for the Amazon S3 bucket.

This field is optional.

conformancePackDetail_lastUpdateRequestedTime :: Lens' ConformancePackDetail (Maybe UTCTime) Source #

The last time a conformation pack update was requested.

conformancePackDetail_templateSSMDocumentDetails :: Lens' ConformancePackDetail (Maybe TemplateSSMDocumentDetails) Source #

An object that contains the name or Amazon Resource Name (ARN) of the Amazon Web Services Systems Manager document (SSM document) and the version of the SSM document that is used to create a conformance pack.

conformancePackDetail_conformancePackArn :: Lens' ConformancePackDetail Text Source #

Amazon Resource Name (ARN) of the conformance pack.

ConformancePackEvaluationFilters

conformancePackEvaluationFilters_complianceType :: Lens' ConformancePackEvaluationFilters (Maybe ConformancePackComplianceType) Source #

Filters the results by compliance.

The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

conformancePackEvaluationFilters_resourceIds :: Lens' ConformancePackEvaluationFilters (Maybe [Text]) Source #

Filters the results by resource IDs.

This is valid only when you provide resource type. If there is no resource type, you will see an error.

conformancePackEvaluationFilters_resourceType :: Lens' ConformancePackEvaluationFilters (Maybe Text) Source #

Filters the results by the resource type (for example, "AWS::EC2::Instance").

ConformancePackEvaluationResult

conformancePackEvaluationResult_annotation :: Lens' ConformancePackEvaluationResult (Maybe Text) Source #

Supplementary information about how the evaluation determined the compliance.

conformancePackEvaluationResult_complianceType :: Lens' ConformancePackEvaluationResult ConformancePackComplianceType Source #

The compliance type. The allowed values are COMPLIANT and NON_COMPLIANT. INSUFFICIENT_DATA is not supported.

conformancePackEvaluationResult_configRuleInvokedTime :: Lens' ConformancePackEvaluationResult UTCTime Source #

The time when Config rule evaluated Amazon Web Services resource.

ConformancePackInputParameter

ConformancePackRuleCompliance

conformancePackRuleCompliance_complianceType :: Lens' ConformancePackRuleCompliance (Maybe ConformancePackComplianceType) Source #

Compliance of the Config rule.

The allowed values are COMPLIANT, NON_COMPLIANT, and INSUFFICIENT_DATA.

conformancePackRuleCompliance_controls :: Lens' ConformancePackRuleCompliance (Maybe [Text]) Source #

Controls for the conformance pack. A control is a process to prevent or detect problems while meeting objectives. A control can align with a specific compliance regime or map to internal controls defined by an organization.

ConformancePackStatusDetail

conformancePackStatusDetail_lastUpdateCompletedTime :: Lens' ConformancePackStatusDetail (Maybe UTCTime) Source #

Last time when conformation pack creation and update was successful.

conformancePackStatusDetail_conformancePackState :: Lens' ConformancePackStatusDetail ConformancePackState Source #

Indicates deployment status of conformance pack.

Config sets the state of the conformance pack to:

  • CREATE_IN_PROGRESS when a conformance pack creation is in progress for an account.
  • CREATE_COMPLETE when a conformance pack has been successfully created in your account.
  • CREATE_FAILED when a conformance pack creation failed in your account.
  • DELETE_IN_PROGRESS when a conformance pack deletion is in progress.
  • DELETE_FAILED when a conformance pack deletion failed in your account.

conformancePackStatusDetail_stackArn :: Lens' ConformancePackStatusDetail Text Source #

Amazon Resource Name (ARN) of CloudFormation stack.

conformancePackStatusDetail_lastUpdateRequestedTime :: Lens' ConformancePackStatusDetail UTCTime Source #

Last time when conformation pack creation and update was requested.

CustomPolicyDetails

customPolicyDetails_enableDebugLogDelivery :: Lens' CustomPolicyDetails (Maybe Bool) Source #

The boolean expression for enabling debug logging for your Config Custom Policy rule. The default value is false.

customPolicyDetails_policyRuntime :: Lens' CustomPolicyDetails Text Source #

The runtime system for your Config Custom Policy rule. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

customPolicyDetails_policyText :: Lens' CustomPolicyDetails Text Source #

The policy definition containing the logic for your Config Custom Policy rule.

DeliveryChannel

deliveryChannel_configSnapshotDeliveryProperties :: Lens' DeliveryChannel (Maybe ConfigSnapshotDeliveryProperties) Source #

The options for how often Config delivers configuration snapshots to the Amazon S3 bucket.

deliveryChannel_name :: Lens' DeliveryChannel (Maybe Text) Source #

The name of the delivery channel. By default, 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.

deliveryChannel_s3BucketName :: Lens' DeliveryChannel (Maybe Text) Source #

The name of the Amazon S3 bucket to which Config delivers configuration snapshots and configuration history files.

If you specify a bucket that belongs to another Amazon Web Services account, that bucket must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon S3 Bucket in the Config Developer Guide.

deliveryChannel_s3KeyPrefix :: Lens' DeliveryChannel (Maybe Text) Source #

The prefix for the specified Amazon S3 bucket.

deliveryChannel_s3KmsKeyArn :: Lens' DeliveryChannel (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Key Management Service (KMS ) KMS key (KMS key) used to encrypt objects delivered by Config. Must belong to the same Region as the destination S3 bucket.

deliveryChannel_snsTopicARN :: Lens' DeliveryChannel (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Amazon SNS topic to which Config sends notifications about configuration changes.

If you choose a topic from another account, the topic must have policies that grant access permissions to Config. For more information, see Permissions for the Amazon SNS Topic in the Config Developer Guide.

DeliveryChannelStatus

deliveryChannelStatus_configHistoryDeliveryInfo :: Lens' DeliveryChannelStatus (Maybe ConfigExportDeliveryInfo) Source #

A list that contains the status of the delivery of the configuration history to the specified Amazon S3 bucket.

deliveryChannelStatus_configSnapshotDeliveryInfo :: Lens' DeliveryChannelStatus (Maybe ConfigExportDeliveryInfo) Source #

A list containing the status of the delivery of the snapshot to the specified Amazon S3 bucket.

deliveryChannelStatus_configStreamDeliveryInfo :: Lens' DeliveryChannelStatus (Maybe ConfigStreamDeliveryInfo) Source #

A list containing the status of the delivery of the configuration stream notification to the specified Amazon SNS topic.

DescribeConfigRulesFilters

describeConfigRulesFilters_evaluationMode :: Lens' DescribeConfigRulesFilters (Maybe EvaluationMode) Source #

The mode of an evaluation. The valid values are Detective or Proactive.

Evaluation

evaluation_annotation :: Lens' Evaluation (Maybe Text) Source #

Supplementary information about how the evaluation determined the compliance.

evaluation_complianceResourceType :: Lens' Evaluation Text Source #

The type of Amazon Web Services resource that was evaluated.

evaluation_complianceResourceId :: Lens' Evaluation Text Source #

The ID of the Amazon Web Services resource that was evaluated.

evaluation_complianceType :: Lens' Evaluation ComplianceType Source #

Indicates whether the Amazon Web Services resource complies with the Config rule that it was evaluated against.

For the Evaluation data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for this data type.

Similarly, Config does not accept INSUFFICIENT_DATA as the value for ComplianceType from a PutEvaluations request. For example, an Lambda function for a custom Config rule cannot pass an INSUFFICIENT_DATA value to Config.

evaluation_orderingTimestamp :: Lens' Evaluation UTCTime Source #

The time of the event in Config that triggered the evaluation. For event-based evaluations, the time indicates when Config created the configuration item that triggered the evaluation. For periodic evaluations, the time indicates when Config triggered the evaluation at the frequency that you specified (for example, every 24 hours).

EvaluationContext

evaluationContext_evaluationContextIdentifier :: Lens' EvaluationContext (Maybe Text) Source #

A unique EvaluationContextIdentifier ID for an EvaluationContext.

EvaluationModeConfiguration

evaluationModeConfiguration_mode :: Lens' EvaluationModeConfiguration (Maybe EvaluationMode) Source #

The mode of an evaluation. The valid values are Detective or Proactive.

EvaluationResult

evaluationResult_annotation :: Lens' EvaluationResult (Maybe Text) Source #

Supplementary information about how the evaluation determined the compliance.

evaluationResult_complianceType :: Lens' EvaluationResult (Maybe ComplianceType) Source #

Indicates whether the Amazon Web Services resource complies with the Config rule that evaluated it.

For the EvaluationResult data type, Config supports only the COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE values. Config does not support the INSUFFICIENT_DATA value for the EvaluationResult data type.

evaluationResult_configRuleInvokedTime :: Lens' EvaluationResult (Maybe UTCTime) Source #

The time when the Config rule evaluated the Amazon Web Services resource.

evaluationResult_resultRecordedTime :: Lens' EvaluationResult (Maybe UTCTime) Source #

The time when Config recorded the evaluation result.

evaluationResult_resultToken :: Lens' EvaluationResult (Maybe Text) Source #

An encrypted token that associates an evaluation with an Config rule. The token identifies the rule, the Amazon Web Services resource being evaluated, and the event that triggered the evaluation.

EvaluationResultIdentifier

evaluationResultIdentifier_evaluationResultQualifier :: Lens' EvaluationResultIdentifier (Maybe EvaluationResultQualifier) Source #

Identifies an Config rule used to evaluate an Amazon Web Services resource, and provides the type and ID of the evaluated resource.

evaluationResultIdentifier_orderingTimestamp :: Lens' EvaluationResultIdentifier (Maybe UTCTime) Source #

The time of the event that triggered the evaluation of your Amazon Web Services resources. The time can indicate when Config delivered a configuration item change notification, or it can indicate when Config delivered the configuration snapshot, depending on which event triggered the evaluation.

EvaluationResultQualifier

evaluationResultQualifier_configRuleName :: Lens' EvaluationResultQualifier (Maybe Text) Source #

The name of the Config rule that was used in the evaluation.

evaluationResultQualifier_evaluationMode :: Lens' EvaluationResultQualifier (Maybe EvaluationMode) Source #

The mode of an evaluation. The valid values are Detective or Proactive.

evaluationResultQualifier_resourceId :: Lens' EvaluationResultQualifier (Maybe Text) Source #

The ID of the evaluated Amazon Web Services resource.

evaluationResultQualifier_resourceType :: Lens' EvaluationResultQualifier (Maybe Text) Source #

The type of Amazon Web Services resource that was evaluated.

EvaluationStatus

evaluationStatus_failureReason :: Lens' EvaluationStatus (Maybe Text) Source #

An explanation for failed execution status.

evaluationStatus_status :: Lens' EvaluationStatus ResourceEvaluationStatus Source #

The status of an execution. The valid values are In_Progress, Succeeded or Failed.

ExecutionControls

ExternalEvaluation

externalEvaluation_annotation :: Lens' ExternalEvaluation (Maybe Text) Source #

Supplementary information about the reason of compliance. For example, this task was completed on a specific date.

externalEvaluation_complianceResourceType :: Lens' ExternalEvaluation Text Source #

The evaluated compliance resource type. Config accepts AWS::::Account resource type.

externalEvaluation_complianceResourceId :: Lens' ExternalEvaluation Text Source #

The evaluated compliance resource ID. Config accepts only Amazon Web Services account ID.

externalEvaluation_complianceType :: Lens' ExternalEvaluation ComplianceType Source #

The compliance of the Amazon Web Services resource. The valid values are COMPLIANT, NON_COMPLIANT, and NOT_APPLICABLE.

externalEvaluation_orderingTimestamp :: Lens' ExternalEvaluation UTCTime Source #

The time when the compliance was recorded.

FailedDeleteRemediationExceptionsBatch

failedDeleteRemediationExceptionsBatch_failureMessage :: Lens' FailedDeleteRemediationExceptionsBatch (Maybe Text) Source #

Returns a failure message for delete remediation exception. For example, Config creates an exception due to an internal error.

FailedRemediationBatch

failedRemediationBatch_failedItems :: Lens' FailedRemediationBatch (Maybe [RemediationConfiguration]) Source #

Returns remediation configurations of the failed items.

failedRemediationBatch_failureMessage :: Lens' FailedRemediationBatch (Maybe Text) Source #

Returns a failure message. For example, the resource is already compliant.

FailedRemediationExceptionBatch

failedRemediationExceptionBatch_failedItems :: Lens' FailedRemediationExceptionBatch (Maybe [RemediationException]) Source #

Returns remediation exception resource key object of the failed items.

failedRemediationExceptionBatch_failureMessage :: Lens' FailedRemediationExceptionBatch (Maybe Text) Source #

Returns a failure message. For example, the auto-remediation has failed.

FieldInfo

GroupedResourceCount

groupedResourceCount_groupName :: Lens' GroupedResourceCount Text Source #

The name of the group that can be region, account ID, or resource type. For example, region1, region2 if the region was chosen as GroupByKey.

MemberAccountStatus

memberAccountStatus_errorCode :: Lens' MemberAccountStatus (Maybe Text) Source #

An error code that is returned when Config rule creation or deletion failed in the member account.

memberAccountStatus_errorMessage :: Lens' MemberAccountStatus (Maybe Text) Source #

An error message indicating that Config rule account creation or deletion has failed due to an error in the member account.

memberAccountStatus_accountId :: Lens' MemberAccountStatus Text Source #

The 12-digit account ID of a member account.

memberAccountStatus_configRuleName :: Lens' MemberAccountStatus Text Source #

The name of Config rule deployed in the member account.

memberAccountStatus_memberAccountRuleStatus :: Lens' MemberAccountStatus MemberAccountRuleStatus Source #

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.
  • CREATE_IN_PROGRESS when Config rule is being created in the member account.
  • CREATE_FAILED when Config rule creation has failed in the member account.
  • DELETE_FAILED when Config rule deletion has failed in the member account.
  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.
  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.
  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.
  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.
  • UPDATE_FAILED when Config rule deletion has failed in the member account.

OrganizationAggregationSource

organizationAggregationSource_allAwsRegions :: Lens' OrganizationAggregationSource (Maybe Bool) Source #

If true, aggregate existing Config regions and future regions.

organizationAggregationSource_roleArn :: Lens' OrganizationAggregationSource Text Source #

ARN of the IAM role used to retrieve Amazon Web Services Organization details associated with the aggregator account.

OrganizationConfigRule

organizationConfigRule_excludedAccounts :: Lens' OrganizationConfigRule (Maybe [Text]) Source #

A comma-separated list of accounts excluded from organization Config rule.

organizationConfigRule_organizationCustomPolicyRuleMetadata :: Lens' OrganizationConfigRule (Maybe OrganizationCustomPolicyRuleMetadataNoPolicy) Source #

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

organizationConfigRule_organizationConfigRuleName :: Lens' OrganizationConfigRule Text Source #

The name that you assign to organization Config rule.

organizationConfigRule_organizationConfigRuleArn :: Lens' OrganizationConfigRule Text Source #

Amazon Resource Name (ARN) of organization Config rule.

OrganizationConfigRuleStatus

organizationConfigRuleStatus_errorCode :: Lens' OrganizationConfigRuleStatus (Maybe Text) Source #

An error code that is returned when organization Config rule creation or deletion has failed.

organizationConfigRuleStatus_errorMessage :: Lens' OrganizationConfigRuleStatus (Maybe Text) Source #

An error message indicating that organization Config rule creation or deletion failed due to an error.

organizationConfigRuleStatus_organizationRuleStatus :: Lens' OrganizationConfigRuleStatus OrganizationRuleStatus Source #

Indicates deployment status of an organization Config rule. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in all the member accounts. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in all the member accounts. Additionally, Config rule status is updated when one or more member accounts join or leave an organization. Config rule status is deleted when the management account deletes OrganizationConfigRule in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when an organization Config rule has been successfully created in all the member accounts.
  • CREATE_IN_PROGRESS when an organization Config rule creation is in progress.
  • CREATE_FAILED when an organization Config rule creation failed in one or more member accounts within that organization.
  • DELETE_FAILED when an organization Config rule deletion failed in one or more member accounts within that organization.
  • DELETE_IN_PROGRESS when an organization Config rule deletion is in progress.
  • DELETE_SUCCESSFUL when an organization Config rule has been successfully deleted from all the member accounts.
  • UPDATE_SUCCESSFUL when an organization Config rule has been successfully updated in all the member accounts.
  • UPDATE_IN_PROGRESS when an organization Config rule update is in progress.
  • UPDATE_FAILED when an organization Config rule update failed in one or more member accounts within that organization.

OrganizationConformancePack

organizationConformancePack_deliveryS3Bucket :: Lens' OrganizationConformancePack (Maybe Text) Source #

The name of the Amazon S3 bucket where Config stores conformance pack templates.

This field is optional.

organizationConformancePack_deliveryS3KeyPrefix :: Lens' OrganizationConformancePack (Maybe Text) Source #

Any folder structure you want to add to an Amazon S3 bucket.

This field is optional.

organizationConformancePack_excludedAccounts :: Lens' OrganizationConformancePack (Maybe [Text]) Source #

A comma-separated list of accounts excluded from organization conformance pack.

organizationConformancePack_organizationConformancePackArn :: Lens' OrganizationConformancePack Text Source #

Amazon Resource Name (ARN) of organization conformance pack.

organizationConformancePack_lastUpdateTime :: Lens' OrganizationConformancePack UTCTime Source #

Last time when organization conformation pack was updated.

OrganizationConformancePackDetailedStatus

organizationConformancePackDetailedStatus_errorCode :: Lens' OrganizationConformancePackDetailedStatus (Maybe Text) Source #

An error code that is returned when conformance pack creation or deletion failed in the member account.

organizationConformancePackDetailedStatus_errorMessage :: Lens' OrganizationConformancePackDetailedStatus (Maybe Text) Source #

An error message indicating that conformance pack account creation or deletion has failed due to an error in the member account.

organizationConformancePackDetailedStatus_status :: Lens' OrganizationConformancePackDetailedStatus OrganizationResourceDetailedStatus Source #

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.
  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.
  • CREATE_FAILED when conformance pack creation has failed in the member account.
  • DELETE_FAILED when conformance pack deletion has failed in the member account.
  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

OrganizationConformancePackStatus

organizationConformancePackStatus_errorCode :: Lens' OrganizationConformancePackStatus (Maybe Text) Source #

An error code that is returned when organization conformance pack creation or deletion has failed in a member account.

organizationConformancePackStatus_errorMessage :: Lens' OrganizationConformancePackStatus (Maybe Text) Source #

An error message indicating that organization conformance pack creation or deletion failed due to an error.

organizationConformancePackStatus_status :: Lens' OrganizationConformancePackStatus OrganizationResourceStatus Source #

Indicates deployment status of an organization conformance pack. When management account calls PutOrganizationConformancePack for the first time, conformance pack status is created in all the member accounts. When management account calls PutOrganizationConformancePack for the second time, conformance pack status is updated in all the member accounts. Additionally, conformance pack status is updated when one or more member accounts join or leave an organization. Conformance pack status is deleted when the management account deletes OrganizationConformancePack in all the member accounts and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when an organization conformance pack has been successfully created in all the member accounts.
  • CREATE_IN_PROGRESS when an organization conformance pack creation is in progress.
  • CREATE_FAILED when an organization conformance pack creation failed in one or more member accounts within that organization.
  • DELETE_FAILED when an organization conformance pack deletion failed in one or more member accounts within that organization.
  • DELETE_IN_PROGRESS when an organization conformance pack deletion is in progress.
  • DELETE_SUCCESSFUL when an organization conformance pack has been successfully deleted from all the member accounts.
  • UPDATE_SUCCESSFUL when an organization conformance pack has been successfully updated in all the member accounts.
  • UPDATE_IN_PROGRESS when an organization conformance pack update is in progress.
  • UPDATE_FAILED when an organization conformance pack update failed in one or more member accounts within that organization.

OrganizationCustomPolicyRuleMetadata

organizationCustomPolicyRuleMetadata_debugLogDeliveryAccounts :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [Text]) Source #

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

organizationCustomPolicyRuleMetadata_description :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text) Source #

The description that you provide for your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadata_inputParameters :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text) Source #

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe MaximumExecutionFrequency) Source #

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

organizationCustomPolicyRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [OrganizationConfigRuleTriggerTypeNoSN]) Source #

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

  • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

organizationCustomPolicyRuleMetadata_resourceIdScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text) Source #

The ID of the Amazon Web Services resource that was evaluated.

organizationCustomPolicyRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [Text]) Source #

The type of the Amazon Web Services resource that was evaluated.

organizationCustomPolicyRuleMetadata_tagKeyScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text) Source #

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.

organizationCustomPolicyRuleMetadata_tagValueScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

organizationCustomPolicyRuleMetadata_policyRuntime :: Lens' OrganizationCustomPolicyRuleMetadata Text Source #

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

organizationCustomPolicyRuleMetadata_policyText :: Lens' OrganizationCustomPolicyRuleMetadata Text Source #

The policy definition containing the logic for your organization Config Custom Policy rule.

OrganizationCustomPolicyRuleMetadataNoPolicy

organizationCustomPolicyRuleMetadataNoPolicy_debugLogDeliveryAccounts :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe [Text]) Source #

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

organizationCustomPolicyRuleMetadataNoPolicy_description :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe Text) Source #

The description that you provide for your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadataNoPolicy_inputParameters :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe Text) Source #

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadataNoPolicy_maximumExecutionFrequency :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe MaximumExecutionFrequency) Source #

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

organizationCustomPolicyRuleMetadataNoPolicy_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe [OrganizationConfigRuleTriggerTypeNoSN]) Source #

The type of notification that triggers Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change triggered notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

organizationCustomPolicyRuleMetadataNoPolicy_policyRuntime :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe Text) Source #

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

organizationCustomPolicyRuleMetadataNoPolicy_tagKeyScope :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe Text) Source #

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.

organizationCustomPolicyRuleMetadataNoPolicy_tagValueScope :: Lens' OrganizationCustomPolicyRuleMetadataNoPolicy (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

OrganizationCustomRuleMetadata

organizationCustomRuleMetadata_description :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

The description that you provide for your organization Config rule.

organizationCustomRuleMetadata_inputParameters :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

A string, in JSON format, that is passed to your organization Config rule Lambda function.

organizationCustomRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationCustomRuleMetadata (Maybe MaximumExecutionFrequency) Source #

The maximum frequency with which Config runs evaluations for a rule. Your custom rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

organizationCustomRuleMetadata_resourceIdScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

The ID of the Amazon Web Services resource that was evaluated.

organizationCustomRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomRuleMetadata (Maybe [Text]) Source #

The type of the Amazon Web Services resource that was evaluated.

organizationCustomRuleMetadata_tagKeyScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

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.

organizationCustomRuleMetadata_tagValueScope :: Lens' OrganizationCustomRuleMetadata (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

organizationCustomRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomRuleMetadata [OrganizationConfigRuleTriggerType] Source #

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.

OrganizationManagedRuleMetadata

organizationManagedRuleMetadata_description :: Lens' OrganizationManagedRuleMetadata (Maybe Text) Source #

The description that you provide for your organization Config rule.

organizationManagedRuleMetadata_inputParameters :: Lens' OrganizationManagedRuleMetadata (Maybe Text) Source #

A string, in JSON format, that is passed to your organization Config rule Lambda function.

organizationManagedRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationManagedRuleMetadata (Maybe MaximumExecutionFrequency) Source #

The maximum frequency with which Config runs evaluations for a rule. This is for an Config managed rule that is triggered at a periodic frequency.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

organizationManagedRuleMetadata_resourceIdScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text) Source #

The ID of the Amazon Web Services resource that was evaluated.

organizationManagedRuleMetadata_resourceTypesScope :: Lens' OrganizationManagedRuleMetadata (Maybe [Text]) Source #

The type of the Amazon Web Services resource that was evaluated.

organizationManagedRuleMetadata_tagKeyScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text) Source #

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.

organizationManagedRuleMetadata_tagValueScope :: Lens' OrganizationManagedRuleMetadata (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

organizationManagedRuleMetadata_ruleIdentifier :: Lens' OrganizationManagedRuleMetadata Text Source #

For organization config managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see Using Config managed rules.

OrganizationResourceDetailedStatusFilters

organizationResourceDetailedStatusFilters_accountId :: Lens' OrganizationResourceDetailedStatusFilters (Maybe Text) Source #

The 12-digit account ID of the member account within an organization.

organizationResourceDetailedStatusFilters_status :: Lens' OrganizationResourceDetailedStatusFilters (Maybe OrganizationResourceDetailedStatus) Source #

Indicates deployment status for conformance pack in a member account. When management account calls PutOrganizationConformancePack action for the first time, conformance pack status is created in the member account. When management account calls PutOrganizationConformancePack action for the second time, conformance pack status is updated in the member account. Conformance pack status is deleted when the management account deletes OrganizationConformancePack and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the conformance pack to:

  • CREATE_SUCCESSFUL when conformance pack has been created in the member account.
  • CREATE_IN_PROGRESS when conformance pack is being created in the member account.
  • CREATE_FAILED when conformance pack creation has failed in the member account.
  • DELETE_FAILED when conformance pack deletion has failed in the member account.
  • DELETE_IN_PROGRESS when conformance pack is being deleted in the member account.
  • DELETE_SUCCESSFUL when conformance pack has been deleted in the member account.
  • UPDATE_SUCCESSFUL when conformance pack has been updated in the member account.
  • UPDATE_IN_PROGRESS when conformance pack is being updated in the member account.
  • UPDATE_FAILED when conformance pack deletion has failed in the member account.

PendingAggregationRequest

pendingAggregationRequest_requesterAccountId :: Lens' PendingAggregationRequest (Maybe Text) Source #

The 12-digit account ID of the account requesting to aggregate data.

QueryInfo

queryInfo_selectFields :: Lens' QueryInfo (Maybe [FieldInfo]) Source #

Returns a FieldInfo object.

RecordingGroup

recordingGroup_allSupported :: Lens' RecordingGroup (Maybe Bool) Source #

Specifies whether Config records configuration changes for every supported type of regional resource.

If you set this option to true, when Config adds support for a new type of regional resource, it starts recording resources of that type automatically.

If you set this option to true, you cannot enumerate a list of resourceTypes.

recordingGroup_includeGlobalResourceTypes :: Lens' RecordingGroup (Maybe Bool) Source #

Specifies whether Config includes all supported types of global resources (for example, IAM resources) with the resources that it records.

Before you can set this option to true, you must set the allSupported option to true.

If you set this option to true, when Config adds support for a new type of global resource, it starts recording resources of that type automatically.

The configuration details for any global resource are the same in all regions. To prevent duplicate configuration items, you should consider customizing Config in only one region to record global resources.

recordingGroup_resourceTypes :: Lens' RecordingGroup (Maybe [ResourceType]) Source #

A comma-separated list that specifies the types of Amazon Web Services resources for which Config records configuration changes (for example, AWS::EC2::Instance or AWS::CloudTrail::Trail).

To record all configuration changes, you must set the allSupported option to true.

If you set this option to false, when 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.

For a list of valid resourceTypes values, see the __resourceType Value__ column in Supported Amazon Web Services resource Types.

Relationship

relationship_relationshipName :: Lens' Relationship (Maybe Text) Source #

The type of relationship with the related resource.

relationship_resourceId :: Lens' Relationship (Maybe Text) Source #

The ID of the related resource (for example, sg-xxxxxx).

relationship_resourceName :: Lens' Relationship (Maybe Text) Source #

The custom name of the related resource, if available.

relationship_resourceType :: Lens' Relationship (Maybe ResourceType) Source #

The resource type of the related resource.

RemediationConfiguration

remediationConfiguration_arn :: Lens' RemediationConfiguration (Maybe Text) Source #

Amazon Resource Name (ARN) of remediation configuration.

remediationConfiguration_automatic :: Lens' RemediationConfiguration (Maybe Bool) Source #

The remediation is triggered automatically.

remediationConfiguration_createdByService :: Lens' RemediationConfiguration (Maybe Text) Source #

Name of the service that owns the service-linked rule, if applicable.

remediationConfiguration_maximumAutomaticAttempts :: Lens' RemediationConfiguration (Maybe Natural) Source #

The maximum number of failed attempts for auto-remediation. If you do not select a number, the default is 5.

For example, if you specify MaximumAutomaticAttempts as 5 with RetryAttemptSeconds as 50 seconds, Config will put a RemediationException on your behalf for the failing resource after the 5th failed attempt within 50 seconds.

remediationConfiguration_retryAttemptSeconds :: Lens' RemediationConfiguration (Maybe Natural) Source #

Maximum time in seconds that Config runs auto-remediation. If you do not select a number, the default is 60 seconds.

For example, if you specify RetryAttemptSeconds as 50 seconds and MaximumAutomaticAttempts as 5, Config will run auto-remediations 5 times within 50 seconds before throwing an exception.

remediationConfiguration_targetVersion :: Lens' RemediationConfiguration (Maybe Text) Source #

Version of the target. For example, version of the SSM document.

If you make backward incompatible changes to the SSM document, you must call PutRemediationConfiguration API again to ensure the remediations can run.

remediationConfiguration_targetType :: Lens' RemediationConfiguration RemediationTargetType Source #

The type of the target. Target executes remediation. For example, SSM document.

remediationConfiguration_targetId :: Lens' RemediationConfiguration Text Source #

Target ID is the name of the public document.

RemediationException

remediationException_expirationTime :: Lens' RemediationException (Maybe UTCTime) Source #

The time when the remediation exception will be deleted.

remediationException_message :: Lens' RemediationException (Maybe Text) Source #

An explanation of an remediation exception.

remediationException_resourceId :: Lens' RemediationException Text Source #

The ID of the resource (for example., sg-xxxxxx).

RemediationExceptionResourceKey

RemediationExecutionStatus

remediationExecutionStatus_lastUpdatedTime :: Lens' RemediationExecutionStatus (Maybe UTCTime) Source #

The time when the remediation execution was last updated.

RemediationExecutionStep

remediationExecutionStep_errorMessage :: Lens' RemediationExecutionStep (Maybe Text) Source #

An error message if the step was interrupted during execution.

RemediationParameterValue

remediationParameterValue_staticValue :: Lens' RemediationParameterValue (Maybe StaticValue) Source #

The value is static and does not change at run-time.

ResourceCount

resourceCount_resourceType :: Lens' ResourceCount (Maybe ResourceType) Source #

The resource type (for example, "AWS::EC2::Instance").

ResourceCountFilters

resourceCountFilters_region :: Lens' ResourceCountFilters (Maybe Text) Source #

The region where the account is located.

resourceCountFilters_resourceType :: Lens' ResourceCountFilters (Maybe ResourceType) Source #

The type of the Amazon Web Services resource.

ResourceDetails

resourceDetails_resourceId :: Lens' ResourceDetails Text Source #

A unique resource ID for an evaluation.

resourceDetails_resourceType :: Lens' ResourceDetails Text Source #

The type of resource being evaluated.

resourceDetails_resourceConfiguration :: Lens' ResourceDetails Text Source #

The resource definition to be evaluated as per the resource configuration schema type.

ResourceEvaluation

resourceEvaluation_evaluationMode :: Lens' ResourceEvaluation (Maybe EvaluationMode) Source #

The mode of an evaluation. The valid values are Detective or Proactive.

resourceEvaluation_resourceEvaluationId :: Lens' ResourceEvaluation (Maybe Text) Source #

The ResourceEvaluationId of a evaluation.

ResourceEvaluationFilters

resourceEvaluationFilters_evaluationContextIdentifier :: Lens' ResourceEvaluationFilters (Maybe Text) Source #

Filters evaluations for a given infrastructure deployment. For example: CFN Stack.

resourceEvaluationFilters_evaluationMode :: Lens' ResourceEvaluationFilters (Maybe EvaluationMode) Source #

Filters all resource evaluations results based on an evaluation mode. the valid value for this API is Proactive.

ResourceFilters

resourceFilters_accountId :: Lens' ResourceFilters (Maybe Text) Source #

The 12-digit source account ID.

ResourceIdentifier

resourceIdentifier_resourceId :: Lens' ResourceIdentifier (Maybe Text) Source #

The ID of the resource (for example, sg-xxxxxx).

resourceIdentifier_resourceName :: Lens' ResourceIdentifier (Maybe Text) Source #

The custom name of the resource (if available).

ResourceKey

resourceKey_resourceId :: Lens' ResourceKey Text Source #

The ID of the resource (for example., sg-xxxxxx).

ResourceValue

RetentionConfiguration

retentionConfiguration_name :: Lens' RetentionConfiguration Text Source #

The name of the retention configuration object.

retentionConfiguration_retentionPeriodInDays :: Lens' RetentionConfiguration Natural Source #

Number of days Config stores your historical information.

Currently, only applicable to the configuration item history.

Scope

scope_complianceResourceId :: Lens' Scope (Maybe Text) Source #

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

scope_complianceResourceTypes :: Lens' Scope (Maybe [Text]) Source #

The resource types of only those Amazon Web Services 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 ComplianceResourceId.

scope_tagKey :: Lens' Scope (Maybe Text) Source #

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

scope_tagValue :: Lens' Scope (Maybe Text) Source #

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Source

source_customPolicyDetails :: Lens' Source (Maybe CustomPolicyDetails) Source #

Provides the runtime system, policy definition, and whether debug logging is enabled. Required when owner is set to CUSTOM_POLICY.

source_sourceDetails :: Lens' Source (Maybe [SourceDetail]) Source #

Provides the source and the message types that cause Config to evaluate your Amazon Web Services resources against a rule. It also provides the frequency with which you want Config to run evaluations for the rule if the trigger type is periodic.

If the owner is set to CUSTOM_POLICY, the only acceptable values for the Config rule trigger message type are ConfigurationItemChangeNotification and OversizedConfigurationItemChangeNotification.

source_sourceIdentifier :: Lens' Source (Maybe Text) Source #

For Config Managed rules, a predefined identifier from a list. For example, IAM_PASSWORD_POLICY is a managed rule. To reference a managed rule, see List of Config Managed Rules.

For Config Custom Lambda rules, the identifier is the Amazon Resource Name (ARN) of the rule's Lambda function, such as arn:aws:lambda:us-east-2:123456789012:function:custom_rule_name.

For Config Custom Policy rules, this field will be ignored.

source_owner :: Lens' Source Owner Source #

Indicates whether Amazon Web Services or the customer owns and manages the Config rule.

Config Managed Rules are predefined rules owned by Amazon Web Services. For more information, see Config Managed Rules in the Config developer guide.

Config Custom Rules are rules that you can develop either with Guard (CUSTOM_POLICY) or Lambda (CUSTOM_LAMBDA). For more information, see Config Custom Rules in the Config developer guide.

SourceDetail

sourceDetail_eventSource :: Lens' SourceDetail (Maybe EventSource) Source #

The source of the event, such as an Amazon Web Services service, that triggers Config to evaluate your Amazon Web Services resources.

sourceDetail_maximumExecutionFrequency :: Lens' SourceDetail (Maybe MaximumExecutionFrequency) Source #

The frequency at which you want Config to run evaluations for a custom rule with a periodic trigger. If you specify a value for MaximumExecutionFrequency, then MessageType must use the ScheduledNotification value.

By default, rules with a periodic trigger are evaluated every 24 hours. To change the frequency, specify a valid value for the MaximumExecutionFrequency parameter.

Based on the valid value you choose, Config runs evaluations once for each valid value. For example, if you choose Three_Hours, Config runs evaluations once every three hours. In this case, Three_Hours is the frequency of this rule.

sourceDetail_messageType :: Lens' SourceDetail (Maybe MessageType) Source #

The type of notification that triggers Config to run an evaluation for a rule. You can specify the following notification types:

  • ConfigurationItemChangeNotification - Triggers an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Triggers an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
  • ScheduledNotification - Triggers a periodic evaluation at the frequency specified for MaximumExecutionFrequency.
  • ConfigurationSnapshotDeliveryCompleted - Triggers a periodic evaluation when Config delivers a configuration snapshot.

If you want your custom rule to be triggered by configuration changes, specify two SourceDetail objects, one for ConfigurationItemChangeNotification and one for OversizedConfigurationItemChangeNotification.

SsmControls

ssmControls_concurrentExecutionRatePercentage :: Lens' SsmControls (Maybe Natural) Source #

The maximum percentage of remediation actions allowed to run in parallel on the non-compliant resources for that specific rule. You can specify a percentage, such as 10%. The default value is 10.

ssmControls_errorPercentage :: Lens' SsmControls (Maybe Natural) Source #

The percentage of errors that are allowed before SSM stops running automations on non-compliant resources for that specific rule. You can specify a percentage of errors, for example 10%. If you do not specifiy a percentage, the default is 50%. For example, if you set the ErrorPercentage to 40% for 10 non-compliant resources, then SSM stops running the automations when the fifth error is received.

StaticValue

staticValue_values :: Lens' StaticValue [Text] Source #

A list of values. For example, the ARN of the assumed role.

StatusDetailFilters

statusDetailFilters_accountId :: Lens' StatusDetailFilters (Maybe Text) Source #

The 12-digit account ID of the member account within an organization.

statusDetailFilters_memberAccountRuleStatus :: Lens' StatusDetailFilters (Maybe MemberAccountRuleStatus) Source #

Indicates deployment status for Config rule in the member account. When management account calls PutOrganizationConfigRule action for the first time, Config rule status is created in the member account. When management account calls PutOrganizationConfigRule action for the second time, Config rule status is updated in the member account. Config rule status is deleted when the management account deletes OrganizationConfigRule and disables service access for config-multiaccountsetup.amazonaws.com.

Config sets the state of the rule to:

  • CREATE_SUCCESSFUL when Config rule has been created in the member account.
  • CREATE_IN_PROGRESS when Config rule is being created in the member account.
  • CREATE_FAILED when Config rule creation has failed in the member account.
  • DELETE_FAILED when Config rule deletion has failed in the member account.
  • DELETE_IN_PROGRESS when Config rule is being deleted in the member account.
  • DELETE_SUCCESSFUL when Config rule has been deleted in the member account.
  • UPDATE_SUCCESSFUL when Config rule has been updated in the member account.
  • UPDATE_IN_PROGRESS when Config rule is being updated in the member account.
  • UPDATE_FAILED when Config rule deletion has failed in the member account.

StoredQuery

storedQuery_description :: Lens' StoredQuery (Maybe Text) Source #

A unique description for the query.

storedQuery_expression :: Lens' StoredQuery (Maybe Text) Source #

The expression of the query. For example, SELECT resourceId, resourceType, supplementaryConfiguration.BucketVersioningConfiguration.status WHERE resourceType = 'AWS::S3::Bucket' AND supplementaryConfiguration.BucketVersioningConfiguration.status = 'Off'.

storedQuery_queryArn :: Lens' StoredQuery (Maybe Text) Source #

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

StoredQueryMetadata

storedQueryMetadata_queryArn :: Lens' StoredQueryMetadata Text Source #

Amazon Resource Name (ARN) of the query. For example, arn:partition:service:region:account-id:resource-type/resource-name/resource-id.

Tag

tag_key :: Lens' Tag (Maybe Text) Source #

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.

tag_value :: Lens' Tag (Maybe Text) Source #

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

TemplateSSMDocumentDetails

templateSSMDocumentDetails_documentVersion :: Lens' TemplateSSMDocumentDetails (Maybe Text) Source #

The version of the SSM document to use to create a conformance pack. By default, Config uses the latest version.

This field is optional.

templateSSMDocumentDetails_documentName :: Lens' TemplateSSMDocumentDetails Text Source #

The name or Amazon Resource Name (ARN) of the SSM document to use to create a conformance pack. If you use the document name, Config checks only your account and Amazon Web Services Region for the SSM document. If you want to use an SSM document from another Region or account, you must provide the ARN.

TimeWindow

timeWindow_endTime :: Lens' TimeWindow (Maybe UTCTime) Source #

The end time of an execution. The end time must be after the start date.

timeWindow_startTime :: Lens' TimeWindow (Maybe UTCTime) Source #

The start time of an execution.