Skip to content

aws.config.describe_remediation_configurations

Example SQL Queries

SELECT * FROM
aws.config.describe_remediation_configurations
WHERE
"config_rule_names" = 'VALUE';

Description

Returns the details of one or more remediation configurations.

Table Definition

Column NameColumn Data Type
config_rule_names Required Input Column

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

VARCHAR[]
Show child fields
config_rule_names[]
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
"type" VARCHAR,
"name" VARCHAR,
"account_id" VARCHAR,
"via_profile_name" VARCHAR,
"assumed_role_arn" VARCHAR,
"organization" STRUCT(
"account_name" VARCHAR,
"id" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[],
"master_account" STRUCT(
"id" VARCHAR,
"email" VARCHAR
),
"parents" STRUCT(
"type" VARCHAR,
"id" VARCHAR,
"name" VARCHAR,
"tags" STRUCT(
"key" VARCHAR,
"value" VARCHAR
)[]
)[]
)
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
remediation_configurations

Returns a remediation configuration object.

STRUCT(
"config_rule_name" VARCHAR,
"target_type" VARCHAR,
"target_id" VARCHAR,
"target_version" VARCHAR,
"parameters" MAP(VARCHAR, STRUCT(
"resource_value" STRUCT(
"value" VARCHAR
),
"static_value" STRUCT(
"values" VARCHAR[]
)
)),
"resource_type" VARCHAR,
"automatic" BOOLEAN,
"execution_controls" STRUCT(
"ssm_controls" STRUCT(
"concurrent_execution_rate_percentage" BIGINT,
"error_percentage" BIGINT
)
),
"maximum_automatic_attempts" BIGINT,
"retry_attempt_seconds" BIGINT,
"arn" VARCHAR,
"created_by_service" VARCHAR
)[]
Show child fields
remediation_configurations[]
Show child fields
remediation_configurations[].arn

Amazon Resource Name (ARN) of remediation configuration.

remediation_configurations[].automatic

The remediation is triggered automatically.

remediation_configurations[].config_rule_name

The name of the Config rule.

remediation_configurations[].created_by_service

Name of the service that owns the service-linked rule, if applicable.

remediation_configurations[].execution_controls

An ExecutionControls object.

Show child fields
remediation_configurations[].execution_controls.ssm_controls

A SsmControls object.

Show child fields
remediation_configurations[].execution_controls.ssm_controls.concurrent_execution_rate_percentage

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.

remediation_configurations[].execution_controls.ssm_controls.error_percentage

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.

remediation_configurations[].maximum_automatic_attempts

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.

remediation_configurations[].parameters

An object of the RemediationParameterValue.

remediation_configurations[].resource_type

The type of a resource.

remediation_configurations[].retry_attempt_seconds

Time window to determine whether or not to add a remediation exception to prevent infinite remediation attempts. If MaximumAutomaticAttempts remediation attempts have been made under RetryAttemptSeconds, a remediation exception will be added to the resource. 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 adding a remediation exception to the resource.

remediation_configurations[].target_id

Target ID is the name of the SSM document.

remediation_configurations[].target_type

The type of the target. Target executes remediation. For example, SSM document.

remediation_configurations[].target_version

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.