Config Service

This page documents function available when using the Config_Service module, created with @service Config_Service.

Index

Documentation

Main.Config_Service.batch_get_aggregate_resource_configMethod
batch_get_aggregate_resource_config(configuration_aggregator_name, resource_identifiers)
batch_get_aggregate_resource_config(configuration_aggregator_name, resource_identifiers, params::Dict{String,<:Any})

Returns the current configuration items for resources that are present in your AWS Config aggregator. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceIdentifiers list. The API does not return results for deleted resources. The API does not return tags and relationships.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.
  • resource_identifiers: A list of aggregate ResourceIdentifiers objects.
source
Main.Config_Service.batch_get_resource_configMethod
batch_get_resource_config(resource_keys)
batch_get_resource_config(resource_keys, params::Dict{String,<:Any})

Returns the current configuration for one or more requested resources. The operation also returns a list of resources that are not processed in the current request. If there are no unprocessed resources, the operation returns an empty unprocessedResourceKeys list. The API does not return results for deleted resources. The API does not return any tags for the requested resources. This information is filtered out of the supplementaryConfiguration section of the API response.

Arguments

  • resource_keys: 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.
source
Main.Config_Service.delete_aggregation_authorizationMethod
delete_aggregation_authorization(authorized_account_id, authorized_aws_region)
delete_aggregation_authorization(authorized_account_id, authorized_aws_region, params::Dict{String,<:Any})

Deletes the authorization granted to the specified configuration aggregator account in a specified region.

Arguments

  • authorized_account_id: The 12-digit account ID of the account authorized to aggregate data.
  • authorized_aws_region: The region authorized to collect aggregated data.
source
Main.Config_Service.delete_config_ruleMethod
delete_config_rule(config_rule_name)
delete_config_rule(config_rule_name, params::Dict{String,<:Any})

Deletes the specified AWS Config rule and all of its evaluation results. AWS Config sets the state of a rule to DELETING until the deletion is complete. You cannot update a rule while it is in this state. If you make a PutConfigRule or DeleteConfigRule request for the rule, you will receive a ResourceInUseException. You can check the state of a rule by using the DescribeConfigRules request.

Arguments

  • config_rule_name: The name of the AWS Config rule that you want to delete.
source
Main.Config_Service.delete_configuration_aggregatorMethod
delete_configuration_aggregator(configuration_aggregator_name)
delete_configuration_aggregator(configuration_aggregator_name, params::Dict{String,<:Any})

Deletes the specified configuration aggregator and the aggregated data associated with the aggregator.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.
source
Main.Config_Service.delete_configuration_recorderMethod
delete_configuration_recorder(configuration_recorder_name)
delete_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})

Deletes the configuration recorder. After the configuration recorder is deleted, AWS Config will not record resource configuration changes until you create a new configuration recorder. This action does not delete the configuration information that was previously recorded. You will be able to access the previously recorded information by using the GetResourceConfigHistory action, but you will not be able to access this information in the AWS Config console until you create a new configuration recorder.

Arguments

  • configuration_recorder_name: The name of the configuration recorder to be deleted. You can retrieve the name of your configuration recorder by using the DescribeConfigurationRecorders action.
source
Main.Config_Service.delete_conformance_packMethod
delete_conformance_pack(conformance_pack_name)
delete_conformance_pack(conformance_pack_name, params::Dict{String,<:Any})

Deletes the specified conformance pack and all the AWS Config rules, remediation actions, and all evaluation results within that conformance pack. AWS Config sets the conformance pack to DELETEINPROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

Arguments

  • conformance_pack_name: Name of the conformance pack you want to delete.
source
Main.Config_Service.delete_delivery_channelMethod
delete_delivery_channel(delivery_channel_name)
delete_delivery_channel(delivery_channel_name, params::Dict{String,<:Any})

Deletes the delivery channel. Before you can delete the delivery channel, you must stop the configuration recorder by using the StopConfigurationRecorder action.

Arguments

  • delivery_channel_name: The name of the delivery channel to delete.
source
Main.Config_Service.delete_evaluation_resultsMethod
delete_evaluation_results(config_rule_name)
delete_evaluation_results(config_rule_name, params::Dict{String,<:Any})

Deletes the evaluation results for the specified AWS Config rule. You can specify one AWS Config rule per request. After you delete the evaluation results, you can call the StartConfigRulesEvaluation API to start evaluating your AWS resources against the rule.

Arguments

  • config_rule_name: The name of the AWS Config rule for which you want to delete the evaluation results.
source
Main.Config_Service.delete_organization_config_ruleMethod
delete_organization_config_rule(organization_config_rule_name)
delete_organization_config_rule(organization_config_rule_name, params::Dict{String,<:Any})

Deletes the specified organization config rule and all of its evaluation results from all member accounts in that organization. Only a master account and a delegated administrator account can delete an organization config rule. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added. AWS Config sets the state of a rule to DELETEINPROGRESS until the deletion is complete. You cannot update a rule while it is in this state.

Arguments

  • organization_config_rule_name: The name of organization config rule that you want to delete.
source
Main.Config_Service.delete_organization_conformance_packMethod
delete_organization_conformance_pack(organization_conformance_pack_name)
delete_organization_conformance_pack(organization_conformance_pack_name, params::Dict{String,<:Any})

Deletes the specified organization conformance pack and all of the config rules and remediation actions from all member accounts in that organization. Only a master account or a delegated administrator account can delete an organization conformance pack. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added. AWS Config sets the state of a conformance pack to DELETEINPROGRESS until the deletion is complete. You cannot update a conformance pack while it is in this state.

Arguments

  • organization_conformance_pack_name: The name of organization conformance pack that you want to delete.
source
Main.Config_Service.delete_pending_aggregation_requestMethod
delete_pending_aggregation_request(requester_account_id, requester_aws_region)
delete_pending_aggregation_request(requester_account_id, requester_aws_region, params::Dict{String,<:Any})

Deletes pending authorization requests for a specified aggregator account in a specified region.

Arguments

  • requester_account_id: The 12-digit account ID of the account requesting to aggregate data.
  • requester_aws_region: The region requesting to aggregate data.
source
Main.Config_Service.delete_remediation_configurationMethod
delete_remediation_configuration(config_rule_name)
delete_remediation_configuration(config_rule_name, params::Dict{String,<:Any})

Deletes the remediation configuration.

Arguments

  • config_rule_name: The name of the AWS Config rule for which you want to delete remediation configuration.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ResourceType": The type of a resource.
source
Main.Config_Service.delete_remediation_exceptionsMethod
delete_remediation_exceptions(config_rule_name, resource_keys)
delete_remediation_exceptions(config_rule_name, resource_keys, params::Dict{String,<:Any})

Deletes one or more remediation exceptions mentioned in the resource keys. AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Arguments

  • config_rule_name: The name of the AWS Config rule for which you want to delete remediation exception configuration.
  • resource_keys: An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.
source
Main.Config_Service.delete_resource_configMethod
delete_resource_config(resource_id, resource_type)
delete_resource_config(resource_id, resource_type, params::Dict{String,<:Any})

Records the configuration state for a custom resource that has been deleted. This API records a new ConfigurationItem with a ResourceDeleted status. You can retrieve the ConfigurationItems recorded for this resource in your AWS Config History.

Arguments

  • resource_id: Unique identifier of the resource.
  • resource_type: The type of the resource.
source
Main.Config_Service.delete_retention_configurationMethod
delete_retention_configuration(retention_configuration_name)
delete_retention_configuration(retention_configuration_name, params::Dict{String,<:Any})

Deletes the retention configuration.

Arguments

  • retention_configuration_name: The name of the retention configuration to delete.
source
Main.Config_Service.delete_stored_queryMethod
delete_stored_query(query_name)
delete_stored_query(query_name, params::Dict{String,<:Any})

Deletes the stored query for a single AWS account and a single AWS Region.

Arguments

  • query_name: The name of the query that you want to delete.
source
Main.Config_Service.deliver_config_snapshotMethod
deliver_config_snapshot(delivery_channel_name)
deliver_config_snapshot(delivery_channel_name, params::Dict{String,<:Any})

Schedules delivery of a configuration snapshot to the Amazon S3 bucket in the specified delivery channel. After the delivery has started, AWS Config sends the following notifications using an Amazon SNS topic that you have specified. Notification of the start of the delivery. Notification of the completion of the delivery, if the delivery was successfully completed. Notification of delivery failure, if the delivery failed.

Arguments

  • delivery_channel_name: The name of the delivery channel through which the snapshot is delivered.
source
Main.Config_Service.describe_aggregate_compliance_by_config_rulesMethod
describe_aggregate_compliance_by_config_rules(configuration_aggregator_name)
describe_aggregate_compliance_by_config_rules(configuration_aggregator_name, params::Dict{String,<:Any})

Returns a list of compliant and noncompliant rules with the number of resources for compliant and noncompliant rules. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the results by ConfigRuleComplianceFilters object.
  • "Limit": The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_aggregate_compliance_by_conformance_packsMethod
describe_aggregate_compliance_by_conformance_packs(configuration_aggregator_name)
describe_aggregate_compliance_by_conformance_packs(configuration_aggregator_name, params::Dict{String,<:Any})

Returns a list of the conformance packs and their associated compliance status with the count of compliant and noncompliant AWS Config rules within each conformance pack. Also returns the total rule count which includes compliant rules, noncompliant rules, and rules that cannot be evaluated due to insufficient data. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the result by AggregateConformancePackComplianceFilters object.
  • "Limit": The maximum number of conformance packs compliance details returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_aggregation_authorizationsMethod
describe_aggregation_authorizations()
describe_aggregation_authorizations(params::Dict{String,<:Any})

Returns a list of authorizations granted to various aggregator accounts and regions.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of AggregationAuthorizations returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_compliance_by_config_ruleMethod
describe_compliance_by_config_rule()
describe_compliance_by_config_rule(params::Dict{String,<:Any})

Indicates whether the specified AWS Config rules are compliant. If a rule is noncompliant, this action returns the number of AWS resources that do not comply with the rule. A rule is compliant if all of the evaluated resources comply with it. It is noncompliant if any of these resources do not comply. If AWS Config has no current evaluation results for the rule, it returns INSUFFICIENTDATA. This result might indicate one of the following conditions: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOTAPPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComplianceTypes": Filters the results by compliance. The allowed values are COMPLIANT and NON_COMPLIANT.
  • "ConfigRuleNames": Specify one or more AWS Config rule names to filter the results by rule.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_compliance_by_resourceMethod
describe_compliance_by_resource()
describe_compliance_by_resource(params::Dict{String,<:Any})

Indicates whether the specified AWS resources are compliant. If a resource is noncompliant, this action returns the number of AWS Config rules that the resource does not comply with. A resource is compliant if it complies with all the AWS Config rules that evaluate it. It is noncompliant if it does not comply with one or more of these rules. If AWS Config has no current evaluation results for the resource, it returns INSUFFICIENTDATA. This result might indicate one of the following conditions about the rules that evaluate the resource: AWS Config has never invoked an evaluation for the rule. To check whether it has, use the DescribeConfigRuleEvaluationStatus action to get the LastSuccessfulInvocationTime and LastFailedInvocationTime. The rule's AWS Lambda function is failing to send evaluation results to AWS Config. Verify that the role that you assigned to your configuration recorder includes the config:PutEvaluations permission. If the rule is a custom rule, verify that the AWS Lambda execution role includes the config:PutEvaluations permission. The rule's AWS Lambda function has returned NOTAPPLICABLE for all evaluation results. This can occur if the resources were deleted or removed from the rule's scope.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComplianceTypes": Filters the results by compliance. The allowed values are COMPLIANT, NONCOMPLIANT, and INSUFFICIENTDATA.
  • "Limit": The maximum number of evaluation results returned on each page. The default is
    1. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the
    default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "ResourceId": The ID of the AWS resource for which you want compliance information. You can specify only one resource ID. If you specify a resource ID, you must also specify a type for ResourceType.
  • "ResourceType": The types of AWS resources for which you want compliance information (for example, AWS::EC2::Instance). For this action, you can specify that the resource type is an AWS account by specifying AWS::::Account.
source
Main.Config_Service.describe_config_rule_evaluation_statusMethod
describe_config_rule_evaluation_status()
describe_config_rule_evaluation_status(params::Dict{String,<:Any})

Returns status information for each of your AWS managed Config rules. The status includes information such as the last time AWS Config invoked the rule, the last time AWS Config failed to invoke the rule, and the related error for the last failure.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigRuleNames": The name of the AWS managed Config rules for which you want status information. If you do not specify any names, AWS Config returns status information for all AWS managed Config rules that you use.
  • "Limit": 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 AWS Config Limits in the AWS General Reference Guide.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_config_rulesMethod
describe_config_rules()
describe_config_rules(params::Dict{String,<:Any})

Returns details about your AWS Config rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigRuleNames": The names of the AWS Config rules for which you want details. If you do not specify any names, AWS Config returns details for all your rules.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_configuration_aggregator_sources_statusMethod
describe_configuration_aggregator_sources_status(configuration_aggregator_name)
describe_configuration_aggregator_sources_status(configuration_aggregator_name, params::Dict{String,<:Any})

Returns status information for sources within an aggregator. The status includes information about the last time AWS Config verified authorization between the source account and an aggregator account. In case of a failure, the status contains the related error code or message.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of AggregatorSourceStatus returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "UpdateStatus": 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.
source
Main.Config_Service.describe_configuration_aggregatorsMethod
describe_configuration_aggregators()
describe_configuration_aggregators(params::Dict{String,<:Any})

Returns the details of one or more configuration aggregators. If the configuration aggregator is not specified, this action returns the details for all the configuration aggregators associated with the account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationAggregatorNames": The name of the configuration aggregators.
  • "Limit": The maximum number of configuration aggregators returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_configuration_recorder_statusMethod
describe_configuration_recorder_status()
describe_configuration_recorder_status(params::Dict{String,<:Any})

Returns the current status of the specified configuration recorder. If a configuration recorder is not specified, this action returns the status of all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationRecorderNames": 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.
source
Main.Config_Service.describe_configuration_recordersMethod
describe_configuration_recorders()
describe_configuration_recorders(params::Dict{String,<:Any})

Returns the details for the specified configuration recorders. If the configuration recorder is not specified, this action returns the details for all configuration recorders associated with the account. Currently, you can specify only one configuration recorder per region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigurationRecorderNames": A list of configuration recorder names.
source
Main.Config_Service.describe_conformance_pack_complianceMethod
describe_conformance_pack_compliance(conformance_pack_name)
describe_conformance_pack_compliance(conformance_pack_name, params::Dict{String,<:Any})

Returns compliance details for each rule in that conformance pack. You must provide exact rule names.

Arguments

  • conformance_pack_name: Name of the conformance pack.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A ConformancePackComplianceFilters object.
  • "Limit": The maximum number of AWS Config rules within a conformance pack are returned on each page.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.describe_conformance_pack_statusMethod
describe_conformance_pack_status()
describe_conformance_pack_status(params::Dict{String,<:Any})

Provides one or more conformance packs deployment status. If there are no conformance packs then you will see an empty result.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConformancePackNames": Comma-separated list of conformance pack names.
  • "Limit": The maximum number of conformance packs status returned on each page.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.describe_conformance_packsMethod
describe_conformance_packs()
describe_conformance_packs(params::Dict{String,<:Any})

Returns a list of one or more conformance packs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConformancePackNames": Comma-separated list of conformance pack names for which you want details. If you do not specify any names, AWS Config returns details for all your conformance packs.
  • "Limit": The maximum number of conformance packs returned on each page.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.describe_delivery_channel_statusMethod
describe_delivery_channel_status()
describe_delivery_channel_status(params::Dict{String,<:Any})

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this action returns the current status of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeliveryChannelNames": A list of delivery channel names.
source
Main.Config_Service.describe_delivery_channelsMethod
describe_delivery_channels()
describe_delivery_channels(params::Dict{String,<:Any})

Returns details about the specified delivery channel. If a delivery channel is not specified, this action returns the details of all delivery channels associated with the account. Currently, you can specify only one delivery channel per region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "DeliveryChannelNames": A list of delivery channel names.
source
Main.Config_Service.describe_organization_config_rule_statusesMethod
describe_organization_config_rule_statuses()
describe_organization_config_rule_statuses(params::Dict{String,<:Any})

Provides organization config rule deployment status for an organization. The status is not considered successful until organization config rule is successfully deployed in all the member accounts with an exception of excluded accounts. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of OrganizationConfigRuleStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "OrganizationConfigRuleNames": The names of organization config rules for which you want status details. If you do not specify any names, AWS Config returns details for all your organization AWS Confg rules.
source
Main.Config_Service.describe_organization_config_rulesMethod
describe_organization_config_rules()
describe_organization_config_rules(params::Dict{String,<:Any})

Returns a list of organization config rules. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization config rule names. It is only applicable, when you request all the organization config rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of organization config rules returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "OrganizationConfigRuleNames": The names of organization config rules for which you want details. If you do not specify any names, AWS Config returns details for all your organization config rules.
source
Main.Config_Service.describe_organization_conformance_pack_statusesMethod
describe_organization_conformance_pack_statuses()
describe_organization_conformance_pack_statuses(params::Dict{String,<:Any})

Provides organization conformance pack deployment status for an organization. The status is not considered successful until organization conformance pack is successfully deployed in all the member accounts with an exception of excluded accounts. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance pack names. They are only applicable, when you request all the organization conformance packs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of OrganizationConformancePackStatuses returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "OrganizationConformancePackNames": The names of organization conformance packs for which you want status details. If you do not specify any names, AWS Config returns details for all your organization conformance packs.
source
Main.Config_Service.describe_organization_conformance_packsMethod
describe_organization_conformance_packs()
describe_organization_conformance_packs(params::Dict{String,<:Any})

Returns a list of organization conformance packs. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you specify organization conformance packs names. They are only applicable, when you request all the organization conformance packs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of organization config packs returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "OrganizationConformancePackNames": The name that you assign to an organization conformance pack.
source
Main.Config_Service.describe_pending_aggregation_requestsMethod
describe_pending_aggregation_requests()
describe_pending_aggregation_requests(params::Dict{String,<:Any})

Returns a list of all pending aggregation requests.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of evaluation results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.describe_remediation_configurationsMethod
describe_remediation_configurations(config_rule_names)
describe_remediation_configurations(config_rule_names, params::Dict{String,<:Any})

Returns the details of one or more remediation configurations.

Arguments

  • config_rule_names: A list of AWS Config rule names of remediation configurations for which you want details.
source
Main.Config_Service.describe_remediation_exceptionsMethod
describe_remediation_exceptions(config_rule_name)
describe_remediation_exceptions(config_rule_name, params::Dict{String,<:Any})

Returns the details of one or more remediation exceptions. A detailed view of a remediation exception for a set of resources that includes an explanation of an exception and the time when the exception will be deleted. When you specify the limit and the next token, you receive a paginated response. AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared. When you specify the limit and the next token, you receive a paginated response. Limit and next token are not applicable if you request resources in batch. It is only applicable, when you request all resources.

Arguments

  • config_rule_name: The name of the AWS Config rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of RemediationExceptionResourceKey returned on each page. The default is 25. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
  • "ResourceKeys": An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.
source
Main.Config_Service.describe_remediation_execution_statusMethod
describe_remediation_execution_status(config_rule_name)
describe_remediation_execution_status(config_rule_name, params::Dict{String,<:Any})

Provides a detailed view of a Remediation Execution for a set of resources including state, timestamps for when steps for the remediation execution occur, and any error messages for steps that have failed. When you specify the limit and the next token, you receive a paginated response.

Arguments

  • config_rule_name: A list of AWS Config rule names.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "ResourceKeys": 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.
source
Main.Config_Service.describe_retention_configurationsMethod
describe_retention_configurations()
describe_retention_configurations(params::Dict{String,<:Any})

Returns the details of one or more retention configurations. If the retention configuration name is not specified, this action returns the details for all the retention configurations for that account. Currently, AWS Config supports only one retention configuration per region in your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "RetentionConfigurationNames": A list of names of retention configurations for which you want details. If you do not specify a name, AWS Config returns details for all the retention configurations for that account. Currently, AWS Config supports only one retention configuration per region in your account.
source
Main.Config_Service.get_aggregate_compliance_details_by_config_ruleMethod
get_aggregate_compliance_details_by_config_rule(account_id, aws_region, config_rule_name, configuration_aggregator_name)
get_aggregate_compliance_details_by_config_rule(account_id, aws_region, config_rule_name, configuration_aggregator_name, params::Dict{String,<:Any})

Returns the evaluation results for the specified AWS Config rule for a specific resource in a rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule. The results can return an empty result page. But if you have a nextToken, the results are displayed on the next page.

Arguments

  • account_id: The 12-digit account ID of the source account.
  • aws_region: The source region from where the data is aggregated.
  • config_rule_name: The name of the AWS Config rule for which you want compliance information.
  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComplianceType": The resource compliance status. For the GetAggregateComplianceDetailsByConfigRuleRequest data type, AWS Config supports only the COMPLIANT and NONCOMPLIANT. AWS Config does not support the NOTAPPLICABLE and INSUFFICIENT_DATA values.
  • "Limit": The maximum number of evaluation results returned on each page. The default is
    1. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the
    default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_aggregate_config_rule_compliance_summaryMethod
get_aggregate_config_rule_compliance_summary(configuration_aggregator_name)
get_aggregate_config_rule_compliance_summary(configuration_aggregator_name, params::Dict{String,<:Any})

Returns the number of compliant and noncompliant rules for one or more accounts and regions in an aggregator. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the results based on the ConfigRuleComplianceSummaryFilters object.
  • "GroupByKey": Groups the result based on ACCOUNTID or AWSREGION.
  • "Limit": The maximum number of evaluation results returned on each page. The default is
    1. You cannot specify a number greater than 1000. If you specify 0, AWS Config uses the
    default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_aggregate_conformance_pack_compliance_summaryMethod
get_aggregate_conformance_pack_compliance_summary(configuration_aggregator_name)
get_aggregate_conformance_pack_compliance_summary(configuration_aggregator_name, params::Dict{String,<:Any})

Returns the count of compliant and noncompliant conformance packs across all AWS Accounts and AWS Regions in an aggregator. You can filter based on AWS Account ID or AWS Region. The results can return an empty result page, but if you have a nextToken, the results are displayed on the next page.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the results based on the AggregateConformancePackComplianceSummaryFilters object.
  • "GroupByKey": Groups the result based on AWS Account ID or AWS Region.
  • "Limit": The maximum number of results returned on each page. The default is maximum. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_aggregate_discovered_resource_countsMethod
get_aggregate_discovered_resource_counts(configuration_aggregator_name)
get_aggregate_discovered_resource_counts(configuration_aggregator_name, params::Dict{String,<:Any})

Returns the resource counts across accounts and regions that are present in your AWS Config aggregator. You can request the resource counts by providing filters and GroupByKey. For example, if the input contains accountID 12345678910 and region us-east-1 in filters, the API returns the count of resources in account ID 12345678910 and region us-east-1. If the input contains ACCOUNT_ID as a GroupByKey, the API returns resource counts for all source accounts that are present in your aggregator.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the results based on the ResourceCountFilters object.
  • "GroupByKey": The key to group the resource counts.
  • "Limit": 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, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_aggregate_resource_configMethod
get_aggregate_resource_config(configuration_aggregator_name, resource_identifier)
get_aggregate_resource_config(configuration_aggregator_name, resource_identifier, params::Dict{String,<:Any})

Returns configuration item that is aggregated for your specific resource in a specific source account and region.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.
  • resource_identifier: An object that identifies aggregate resource.
source
Main.Config_Service.get_compliance_details_by_config_ruleMethod
get_compliance_details_by_config_rule(config_rule_name)
get_compliance_details_by_config_rule(config_rule_name, params::Dict{String,<:Any})

Returns the evaluation results for the specified AWS Config rule. The results indicate which AWS resources were evaluated by the rule, when each resource was last evaluated, and whether each resource complies with the rule.

Arguments

  • config_rule_name: The name of the AWS Config rule for which you want compliance information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComplianceTypes": Filters the results by compliance. The allowed values are COMPLIANT, NONCOMPLIANT, and NOTAPPLICABLE.
  • "Limit": The maximum number of evaluation results returned on each page. The default is
    1. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the
    default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_compliance_details_by_resourceMethod
get_compliance_details_by_resource(resource_id, resource_type)
get_compliance_details_by_resource(resource_id, resource_type, params::Dict{String,<:Any})

Returns the evaluation results for the specified AWS resource. The results indicate which AWS Config rules were used to evaluate the resource, when each rule was last used, and whether the resource complies with each rule.

Arguments

  • resource_id: The ID of the AWS resource for which you want compliance information.
  • resource_type: The type of the AWS resource for which you want compliance information.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ComplianceTypes": Filters the results by compliance. The allowed values are COMPLIANT, NONCOMPLIANT, and NOTAPPLICABLE.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_compliance_summary_by_resource_typeMethod
get_compliance_summary_by_resource_type()
get_compliance_summary_by_resource_type(params::Dict{String,<:Any})

Returns the number of resources that are compliant and the number that are noncompliant. You can specify one or more resource types to get these numbers for each resource type. The maximum number returned is 100.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ResourceTypes": 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 AWS resource type such as AWS::EC2::Instance. You can specify that the resource type is an AWS account by specifying AWS::::Account.
source
Main.Config_Service.get_conformance_pack_compliance_detailsMethod
get_conformance_pack_compliance_details(conformance_pack_name)
get_conformance_pack_compliance_details(conformance_pack_name, params::Dict{String,<:Any})

Returns compliance details of a conformance pack for all AWS resources that are monitered by conformance pack.

Arguments

  • conformance_pack_name: Name of the conformance pack.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A ConformancePackEvaluationFilters object.
  • "Limit": The maximum number of evaluation results returned on each page. If you do no specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.get_conformance_pack_compliance_summaryMethod
get_conformance_pack_compliance_summary(conformance_pack_names)
get_conformance_pack_compliance_summary(conformance_pack_names, params::Dict{String,<:Any})

Returns compliance details for the conformance pack based on the cumulative compliance results of all the rules in that conformance pack.

Arguments

  • conformance_pack_names: Names of conformance packs.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of conformance packs returned on each page.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_discovered_resource_countsMethod
get_discovered_resource_counts()
get_discovered_resource_counts(params::Dict{String,<:Any})

Returns the resource types, the number of each resource type, and the total number of resources that AWS Config is recording in this region for your AWS account. Example AWS 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. You make a call to the GetDiscoveredResourceCounts action and specify that you want all resource types. AWS Config returns the following: The resource types (EC2 instances, IAM users, and S3 buckets). The number of each resource type (25, 20, and 15). The total number of all resources (60). The response is paginated. By default, AWS Config lists 100 ResourceCount objects on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. If you make a call to the GetDiscoveredResourceCounts action, you might not immediately receive resource counts in the following situations: You are a new AWS Config customer. You just enabled resource recording. It might take a few minutes for AWS Config to record and count your resources. Wait a few minutes and then retry the GetDiscoveredResourceCounts action.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "limit": 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, AWS Config uses the default.
  • "nextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "resourceTypes": The comma-separated list that specifies the resource types that you want AWS Config to return (for example, "AWS::EC2::Instance", "AWS::IAM::User"). If a value for resourceTypes is not specified, AWS Config returns all resource types that AWS Config is recording in the region for your account. If the configuration recorder is turned off, AWS 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.
source
Main.Config_Service.get_organization_config_rule_detailed_statusMethod
get_organization_config_rule_detailed_status(organization_config_rule_name)
get_organization_config_rule_detailed_status(organization_config_rule_name, params::Dict{String,<:Any})

Returns detailed status for each member account within an organization for a given organization config rule.

Arguments

  • organization_config_rule_name: The name of organization config rule for which you want status details for member accounts.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": A StatusDetailFilters object.
  • "Limit": The maximum number of OrganizationConfigRuleDetailedStatus returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_organization_conformance_pack_detailed_statusMethod
get_organization_conformance_pack_detailed_status(organization_conformance_pack_name)
get_organization_conformance_pack_detailed_status(organization_conformance_pack_name, params::Dict{String,<:Any})

Returns detailed status for each member account within an organization for a given organization conformance pack.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": An OrganizationResourceDetailedStatusFilters object.
  • "Limit": The maximum number of OrganizationConformancePackDetailedStatuses returned on each page. If you do not specify a number, AWS Config uses the default. The default is 100.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_resource_config_historyMethod
get_resource_config_history(resource_id, resource_type)
get_resource_config_history(resource_id, resource_type, params::Dict{String,<:Any})

Returns a list of configuration items for the specified resource. The list contains details about each state of the resource during the specified time interval. If you specified a retention period to retain your ConfigurationItems between a minimum of 30 days and a maximum of 7 years (2557 days), AWS Config returns the ConfigurationItems for the specified retention period. The response is paginated. By default, AWS Config returns a limit of 10 configuration items per page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter. Each call to the API is limited to span a duration of seven days. It is likely that the number of records returned is smaller than the specified limit. In such cases, you can make another call, using the nextToken.

Arguments

  • resource_id: The ID of the resource (for example., sg-xxxxxx).
  • resource_type: The resource type.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "chronologicalOrder": The chronological order for configuration items listed. By default, the results are listed in reverse chronological order.
  • "earlierTime": 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.
  • "laterTime": The time stamp that indicates a later time. If not specified, current time is taken.
  • "limit": The maximum number of configuration items returned on each page. The default is 10. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.
  • "nextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.get_stored_queryMethod
get_stored_query(query_name)
get_stored_query(query_name, params::Dict{String,<:Any})

Returns the details of a specific stored query.

Arguments

  • query_name: The name of the query.
source
Main.Config_Service.list_aggregate_discovered_resourcesMethod
list_aggregate_discovered_resources(configuration_aggregator_name, resource_type)
list_aggregate_discovered_resources(configuration_aggregator_name, resource_type, params::Dict{String,<:Any})

Accepts a resource type and returns a list of resource identifiers that are aggregated for a specific resource type across accounts and regions. A resource identifier includes the resource type, ID, (if available) the custom resource name, source account, and source region. You can narrow the results to include only resources that have specific resource IDs, or a resource name, or source account ID, or source region. For example, if the input consists of accountID 12345678910 and the region is us-east-1 for resource type AWS::EC2::Instance then the API returns all the EC2 instance identifiers of accountID 12345678910 and region us-east-1.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.
  • resource_type: The type of resources that you want AWS Config to list in the response.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Filters": Filters the results based on the ResourceFilters object.
  • "Limit": The maximum number of resource identifiers returned on each page. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.list_discovered_resourcesMethod
list_discovered_resources(resource_type)
list_discovered_resources(resource_type, params::Dict{String,<:Any})

Accepts a resource type and returns a list of resource identifiers for the resources of that type. A resource identifier includes the resource type, ID, and (if available) the custom resource name. The results consist of resources that AWS Config has discovered, including those that AWS Config is not currently recording. You can narrow the results to include only resources that have specific resource IDs or a resource name. You can specify either resource IDs or a resource name, but not both, in the same request. The response is paginated. By default, AWS Config lists 100 resource identifiers on each page. You can customize this number with the limit parameter. The response includes a nextToken string. To get the next page of results, run the request again and specify the string for the nextToken parameter.

Arguments

  • resource_type: The type of resources that you want AWS Config to list in the response.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "includeDeletedResources": Specifies whether AWS Config includes deleted resources in the results. By default, deleted resources are not included.
  • "limit": The maximum number of resource identifiers returned on each page. The default is 100. You cannot specify a number greater than 100. If you specify 0, AWS Config uses the default.
  • "nextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
  • "resourceIds": The IDs of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
  • "resourceName": The custom name of only those resources that you want AWS Config to list in the response. If you do not specify this parameter, AWS Config lists all resources of the specified type that it has discovered.
source
Main.Config_Service.list_stored_queriesMethod
list_stored_queries()
list_stored_queries(params::Dict{String,<:Any})

Lists the stored queries for a single AWS account and a single AWS Region. The default is

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": The maximum number of results to be returned with a single call.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

List the tags for AWS Config resource.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of tags returned on each page. The limit maximum is 50. You cannot specify a number greater than 50. If you specify 0, AWS Config uses the default.
  • "NextToken": The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
source
Main.Config_Service.put_aggregation_authorizationMethod
put_aggregation_authorization(authorized_account_id, authorized_aws_region)
put_aggregation_authorization(authorized_account_id, authorized_aws_region, params::Dict{String,<:Any})

Authorizes the aggregator account and region to collect data from the source account and region.

Arguments

  • authorized_account_id: The 12-digit account ID of the account authorized to aggregate data.
  • authorized_aws_region: The region authorized to collect aggregated data.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": An array of tag object.
source
Main.Config_Service.put_config_ruleMethod
put_config_rule(config_rule)
put_config_rule(config_rule, params::Dict{String,<:Any})

Adds or updates an AWS Config rule for evaluating whether your AWS resources comply with your desired configurations. You can use this action for custom AWS Config rules and AWS managed Config rules. A custom AWS Config rule is a rule that you develop and maintain. An AWS managed Config rule is a customizable, predefined rule that AWS Config provides. If you are adding a new custom AWS Config rule, you must first create the AWS Lambda function that the rule invokes to evaluate your resources. When you use the PutConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. Specify the ARN for the SourceIdentifier key. This key is part of the Source object, which is part of the ConfigRule object. If you are adding an AWS managed Config rule, specify the rule's identifier for the SourceIdentifier key. To reference AWS managed Config rule identifiers, see About AWS Managed Config Rules. For any new rule that you add, specify the ConfigRuleName in the ConfigRule object. Do not specify the ConfigRuleArn or the ConfigRuleId. These values are generated by AWS Config for new rules. If you are updating a rule that you added previously, you can specify the rule by ConfigRuleName, ConfigRuleId, or ConfigRuleArn in the ConfigRule data type that you use in this request. The maximum number of rules that AWS Config supports is 150. For information about requesting a rule limit increase, see AWS Config Limits in the AWS General Reference Guide. For more information about developing and using AWS Config rules, see Evaluating AWS Resource Configurations with AWS Config in the AWS Config Developer Guide.

Arguments

  • config_rule: The rule that you want to add to your account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": An array of tag object.
source
Main.Config_Service.put_configuration_aggregatorMethod
put_configuration_aggregator(configuration_aggregator_name)
put_configuration_aggregator(configuration_aggregator_name, params::Dict{String,<:Any})

Creates and updates the configuration aggregator with the selected source accounts and regions. The source account can be individual account(s) or an organization. accountIds that are passed will be replaced with existing accounts. If you want to add additional accounts into the aggregator, call DescribeAggregator to get the previous accounts and then append new ones. AWS Config should be enabled in source accounts and regions you want to aggregate. If your source type is an organization, you must be signed in to the management account or a registered delegated administrator and all the features must be enabled in your organization. If the caller is a management account, AWS Config calls EnableAwsServiceAccess API to enable integration between AWS Config and AWS Organizations. If the caller is a registered delegated administrator, AWS Config calls ListDelegatedAdministrators API to verify whether the caller is a valid delegated administrator. To register a delegated administrator, see Register a Delegated Administrator in the AWS Config developer guide.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "AccountAggregationSources": A list of AccountAggregationSource object.
  • "OrganizationAggregationSource": An OrganizationAggregationSource object.
  • "Tags": An array of tag object.
source
Main.Config_Service.put_configuration_recorderMethod
put_configuration_recorder(configuration_recorder)
put_configuration_recorder(configuration_recorder, params::Dict{String,<:Any})

Creates a new configuration recorder to record the selected resource configurations. You can use this action to change the role roleARN or the recordingGroup of an existing recorder. To change the role, call the action on the existing configuration recorder and specify a role. Currently, you can specify only one configuration recorder per region in your account. If ConfigurationRecorder does not have the recordingGroup parameter specified, the default is to record all supported resource types.

Arguments

  • configuration_recorder: The configuration recorder object that records each configuration change made to the resources.
source
Main.Config_Service.put_conformance_packMethod
put_conformance_pack(conformance_pack_name)
put_conformance_pack(conformance_pack_name, params::Dict{String,<:Any})

Creates or updates a conformance pack. A conformance pack is a collection of AWS Config rules that can be easily deployed in an account and a region and across AWS Organization. This API creates a service linked role AWSServiceRoleForConfigConforms in your account. The service linked role is created only when the role does not exist in your account. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter.

Arguments

  • conformance_pack_name: Name of the conformance pack you want to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConformancePackInputParameters": A list of ConformancePackInputParameter objects.
  • "DeliveryS3Bucket": Amazon S3 bucket where AWS Config stores conformance pack templates. This field is optional.
  • "DeliveryS3KeyPrefix": The prefix for the Amazon S3 bucket. This field is optional.
  • "TemplateBody": 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. You can only use a YAML template with one resource type, that is, config rule and a remediation action.
  • "TemplateS3Uri": Location of file containing the template body (s3://bucketname/prefix). The uri must point to the 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.
source
Main.Config_Service.put_delivery_channelMethod
put_delivery_channel(delivery_channel)
put_delivery_channel(delivery_channel, params::Dict{String,<:Any})

Creates a delivery channel object to deliver configuration information to an Amazon S3 bucket and Amazon SNS topic. Before you can create a delivery channel, you must create a configuration recorder. You can use this action to change the Amazon S3 bucket or an Amazon SNS topic of the existing delivery channel. To change the Amazon S3 bucket or an Amazon SNS topic, call this action and specify the changed values for the S3 bucket and the SNS topic. If you specify a different value for either the S3 bucket or the SNS topic, this action will keep the existing value for the parameter that is not changed. You can have only one delivery channel per region in your account.

Arguments

  • delivery_channel: The configuration delivery channel object that delivers the configuration information to an Amazon S3 bucket and to an Amazon SNS topic.
source
Main.Config_Service.put_evaluationsMethod
put_evaluations(result_token)
put_evaluations(result_token, params::Dict{String,<:Any})

Used by an AWS Lambda function to deliver evaluation results to AWS Config. This action is required in every AWS Lambda function that is invoked by an AWS Config rule.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Evaluations": The assessments that the AWS Lambda function performs. Each evaluation identifies an AWS resource and indicates whether it complies with the AWS Config rule that invokes the AWS Lambda function.
  • "TestMode": Use this parameter to specify a test run for PutEvaluations. You can verify whether your AWS Lambda function will deliver evaluation results to AWS Config. No updates occur to your existing evaluations, and evaluation results are not sent to AWS Config. When TestMode is true, PutEvaluations doesn't require a valid value for the ResultToken parameter, but the value cannot be null.
source
Main.Config_Service.put_external_evaluationMethod
put_external_evaluation(config_rule_name, external_evaluation)
put_external_evaluation(config_rule_name, external_evaluation, params::Dict{String,<:Any})

Add or updates the evaluations for process checks. This API checks if the rule is a process check when the name of the AWS Config rule is provided.

Arguments

  • config_rule_name: The name of the AWS Config rule.
  • external_evaluation: An ExternalEvaluation object that provides details about compliance.
source
Main.Config_Service.put_organization_config_ruleMethod
put_organization_config_rule(organization_config_rule_name)
put_organization_config_rule(organization_config_rule_name, params::Dict{String,<:Any})

Adds or updates organization config rule for your entire organization evaluating whether your AWS resources comply with your desired configurations. Only a master account and a delegated administrator can create or update an organization config rule. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added. This API enables organization service access through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. AWS Config verifies the existence of role with GetRole action. To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegated-administrator for config-multiaccountsetup.amazonaws.com. You can use this action to create both custom AWS Config rules and AWS managed Config rules. If you are adding a new custom AWS Config rule, you must first create AWS Lambda function in the master account or a delegated administrator that the rule invokes to evaluate your resources. When you use the PutOrganizationConfigRule action to add the rule to AWS Config, you must specify the Amazon Resource Name (ARN) that AWS Lambda assigns to the function. If you are adding an AWS managed Config rule, specify the rule's identifier for the RuleIdentifier key. The maximum number of organization config rules that AWS Config supports is 150 and 3 delegated administrator per organization. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. Specify either OrganizationCustomRuleMetadata or OrganizationManagedRuleMetadata.

Arguments

  • organization_config_rule_name: The name that you assign to an organization config rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExcludedAccounts": A comma-separated list of accounts that you want to exclude from an organization config rule.
  • "OrganizationCustomRuleMetadata": An OrganizationCustomRuleMetadata object.
  • "OrganizationManagedRuleMetadata": An OrganizationManagedRuleMetadata object.
source
Main.Config_Service.put_organization_conformance_packMethod
put_organization_conformance_pack(organization_conformance_pack_name)
put_organization_conformance_pack(organization_conformance_pack_name, params::Dict{String,<:Any})

Deploys conformance packs across member accounts in an AWS Organization. Only a master account and a delegated administrator can call this API. When calling this API with a delegated administrator, you must ensure AWS Organizations ListDelegatedAdministrator permissions are added. This API enables organization service access for config-multiaccountsetup.amazonaws.com through the EnableAWSServiceAccess action and creates a service linked role AWSServiceRoleForConfigMultiAccountSetup in the master or delegated administrator account of your organization. The service linked role is created only when the role does not exist in the caller account. To use this API with delegated administrator, register a delegated administrator by calling AWS Organization register-delegate-admin for config-multiaccountsetup.amazonaws.com. Prerequisite: Ensure you call EnableAllFeatures API to enable all features in an organization. You must specify either the TemplateS3Uri or the TemplateBody parameter, but not both. If you provide both AWS Config uses the TemplateS3Uri parameter and ignores the TemplateBody parameter. AWS Config sets the state of a conformance pack to CREATEINPROGRESS and UPDATEINPROGRESS until the conformance pack is created or updated. You cannot update a conformance pack while it is in this state. You can create 50 conformance packs with 25 AWS Config rules in each pack and 3 delegated administrator per organization.

Arguments

  • organization_conformance_pack_name: Name of the organization conformance pack you want to create.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConformancePackInputParameters": A list of ConformancePackInputParameter objects.
  • "DeliveryS3Bucket": Amazon S3 bucket where AWS Config stores conformance pack templates. This field is optional. If used, it must be prefixed with awsconfigconforms.
  • "DeliveryS3KeyPrefix": The prefix for the Amazon S3 bucket. This field is optional.
  • "ExcludedAccounts": A list of AWS accounts to be excluded from an organization conformance pack while deploying a conformance pack.
  • "TemplateBody": 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.
  • "TemplateS3Uri": 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.
source
Main.Config_Service.put_remediation_configurationsMethod
put_remediation_configurations(remediation_configurations)
put_remediation_configurations(remediation_configurations, params::Dict{String,<:Any})

Adds or updates the remediation configuration with a specific AWS Config rule with the selected target or action. The API creates the RemediationConfiguration object for the AWS Config rule. The AWS Config rule must already exist for you to add a remediation configuration. The target (SSM document) must exist and have permissions to use the target. If you make backward incompatible changes to the SSM document, you must call this again to ensure the remediations can run. This API does not support adding remediation configurations for service-linked AWS Config Rules such as Organization Config rules, the rules deployed by conformance packs, and rules deployed by AWS Security Hub.

Arguments

  • remediation_configurations: A list of remediation configuration objects.
source
Main.Config_Service.put_remediation_exceptionsMethod
put_remediation_exceptions(config_rule_name, resource_keys)
put_remediation_exceptions(config_rule_name, resource_keys, params::Dict{String,<:Any})

A remediation exception is when a specific resource is no longer considered for auto-remediation. This API adds a new exception or updates an existing exception for a specific resource with a specific AWS Config rule. AWS Config generates a remediation exception when a problem occurs executing a remediation action to a specific resource. Remediation exceptions blocks auto-remediation until the exception is cleared.

Arguments

  • config_rule_name: The name of the AWS Config rule for which you want to create remediation exception.
  • resource_keys: An exception list of resource exception keys to be processed with the current request. AWS Config adds exception for each resource key. For example, AWS Config adds 3 exceptions for 3 resource keys.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ExpirationTime": The exception is automatically deleted after the expiration date.
  • "Message": The message contains an explanation of the exception.
source
Main.Config_Service.put_resource_configMethod
put_resource_config(configuration, resource_id, resource_type, schema_version_id)
put_resource_config(configuration, resource_id, resource_type, schema_version_id, params::Dict{String,<:Any})

Records the configuration state for the resource provided in the request. The configuration state of a resource is represented in AWS Config as Configuration Items. Once this API records the configuration item, you can retrieve the list of configuration items for the custom resource type using existing AWS Config APIs. The custom resource type must be registered with AWS CloudFormation. This API accepts the configuration item registered with AWS CloudFormation. When you call this API, AWS Config only stores configuration state of the resource provided in the request. This API does not change or remediate the configuration of the resource. Write-only schema properites are not recorded as part of the published configuration item.

Arguments

  • configuration: The configuration object of the resource in valid JSON format. It must match the schema registered with AWS CloudFormation. The configuration JSON must not exceed 64 KB.
  • resource_id: Unique identifier of the resource.
  • resource_type: The type of the resource. The custom resource type must be registered with AWS CloudFormation. You cannot use the organization names “aws”, “amzn”, “amazon”, “alexa”, “custom” with custom resource types. It is the first part of the ResourceType up to the first ::.
  • schema_version_id: Version of the schema registered for the ResourceType in AWS CloudFormation.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ResourceName": Name of the resource.
  • "Tags": Tags associated with the resource.
source
Main.Config_Service.put_retention_configurationMethod
put_retention_configuration(retention_period_in_days)
put_retention_configuration(retention_period_in_days, params::Dict{String,<:Any})

Creates and updates the retention configuration with details about retention period (number of days) that AWS Config stores your historical information. The API creates the RetentionConfiguration object and names the object as default. When you have a RetentionConfiguration object named default, calling the API modifies the default object. Currently, AWS Config supports only one retention configuration per region in your account.

Arguments

  • retention_period_in_days: Number of days AWS Config stores your historical information. Currently, only applicable to the configuration item history.
source
Main.Config_Service.put_stored_queryMethod
put_stored_query(stored_query)
put_stored_query(stored_query, params::Dict{String,<:Any})

Saves a new query or updates an existing saved query. The QueryName must be unique for a single AWS account and a single AWS Region. You can create upto 300 queries in a single AWS account and a single AWS Region.

Arguments

  • stored_query: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A list of Tags object.
source
Main.Config_Service.select_aggregate_resource_configMethod
select_aggregate_resource_config(configuration_aggregator_name, expression)
select_aggregate_resource_config(configuration_aggregator_name, expression, params::Dict{String,<:Any})

Accepts a structured query language (SQL) SELECT command and an aggregator to query configuration state of AWS resources across multiple accounts and regions, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the AWS Config Developer Guide.

Arguments

  • configuration_aggregator_name: The name of the configuration aggregator.
  • expression: The SQL query SELECT command.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of query results returned on each page.
  • "MaxResults": The maximum number of query results returned on each page. AWS Config also allows the Limit request parameter.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.select_resource_configMethod
select_resource_config(expression)
select_resource_config(expression, params::Dict{String,<:Any})

Accepts a structured query language (SQL) SELECT command, performs the corresponding search, and returns resource configurations matching the properties. For more information about query components, see the Query Components section in the AWS Config Developer Guide.

Arguments

  • expression: The SQL query SELECT command.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Limit": The maximum number of query results returned on each page.
  • "NextToken": The nextToken string returned in a previous request that you use to request the next page of results in a paginated response.
source
Main.Config_Service.start_config_rules_evaluationMethod
start_config_rules_evaluation()
start_config_rules_evaluation(params::Dict{String,<:Any})

Runs an on-demand evaluation for the specified AWS Config rules against the last known configuration state of the resources. Use StartConfigRulesEvaluation when you want to test that a rule you updated is working as expected. StartConfigRulesEvaluation does not re-record the latest configuration state for your resources. It re-runs an evaluation against the last known state of your resources. You can specify up to 25 AWS Config rules per request. An existing StartConfigRulesEvaluation call for the specified rules must complete before you can call the API again. If you chose to have AWS Config stream to an Amazon SNS topic, you will receive a ConfigRuleEvaluationStarted notification when the evaluation starts. You don't need to call the StartConfigRulesEvaluation API to run an evaluation for a new rule. When you create a rule, AWS Config evaluates your resources against the rule automatically. The StartConfigRulesEvaluation API is useful if you want to run on-demand evaluations, such as the following example: You have a custom rule that evaluates your IAM resources every 24 hours. You update your Lambda function to add additional conditions to your rule. Instead of waiting for the next periodic evaluation, you call the StartConfigRulesEvaluation API. AWS Config invokes your Lambda function and evaluates your IAM resources. Your custom rule will still run periodic evaluations every 24 hours.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ConfigRuleNames": The list of names of AWS Config rules that you want to run evaluations for.
source
Main.Config_Service.start_configuration_recorderMethod
start_configuration_recorder(configuration_recorder_name)
start_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})

Starts recording configurations of the AWS resources you have selected to record in your AWS account. You must have created at least one delivery channel to successfully start the configuration recorder.

Arguments

  • configuration_recorder_name: The name of the recorder object that records each configuration change made to the resources.
source
Main.Config_Service.start_remediation_executionMethod
start_remediation_execution(config_rule_name, resource_keys)
start_remediation_execution(config_rule_name, resource_keys, params::Dict{String,<:Any})

Runs an on-demand remediation for the specified AWS Config rules against the last known remediation configuration. It runs an execution against the current state of your resources. Remediation execution is asynchronous. You can specify up to 100 resource keys per request. An existing StartRemediationExecution call for the specified resource keys must complete before you can call the API again.

Arguments

  • config_rule_name: The list of names of AWS Config rules that you want to run remediation execution for.
  • resource_keys: 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.
source
Main.Config_Service.stop_configuration_recorderMethod
stop_configuration_recorder(configuration_recorder_name)
stop_configuration_recorder(configuration_recorder_name, params::Dict{String,<:Any})

Stops recording configurations of the AWS resources you have selected to record in your AWS account.

Arguments

  • configuration_recorder_name: The name of the recorder object that records each configuration change made to the resources.
source
Main.Config_Service.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Associates the specified tags to a resource with the specified resourceArn. If existing tags on a resource are not specified in the request parameters, they are not changed. When a resource is deleted, the tags associated with that resource are deleted as well.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.
  • tags: An array of tag object.
source
Main.Config_Service.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Deletes specified tags from a resource.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) that identifies the resource for which to list the tags. Currently, the supported resources are ConfigRule, ConfigurationAggregator and AggregatorAuthorization.
  • tag_keys: The keys of the tags to be removed.
source