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.
Parameters:
-
config_rule_name
(ConfigRuleName)
–
The name of the Config rule.
-
resource_keys
(Optional[ResourceKeys], default:
None
)
–
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.
-
limit
(Optional[Limit], default:
None
)
–
The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default.
-
next_token
(Optional[String], default:
None
)
–
The nextToken string returned on a previous page that you use to get the next page of results in a paginated response.
Raises:
Source code in docs_src/capo_config_service/_services/config_service.py
| def describe_remediation_execution_status(
self,
config_rule_name: "capo_config_service.types.config_rule_name.ConfigRuleName",
*,
config_overrides: Optional[ConfigServiceClientConfig] = None,
resource_keys: Optional[
"capo_config_service.types.resource_keys.ResourceKeys"
] = None,
limit: Optional["capo_config_service.types.limit.Limit"] = None,
next_token: Optional["capo_config_service.types.string.String"] = None,
) -> "capo_config_service.types.describe_remediation_execution_status_response.DescribeRemediationExecutionStatusResponse":
"""<p>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.</p>
Args:
config_rule_name: <p>The name of the Config rule.</p>
resource_keys: <p>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. </p>
limit: <p>The maximum number of RemediationExecutionStatuses returned on each page. The default is maximum. If you specify 0, Config uses the default. </p>
next_token: <p>The <code>nextToken</code> string returned on a previous page that you use to get the next page of results in a paginated response.</p>
Raises:
capo_config_service.errors.invalid_next_token_exception.InvalidNextTokenException: <p>The specified next token is not valid. Specify the <code>nextToken</code> string that was returned in the previous response to get the next page of results.</p>
capo_config_service.errors.invalid_parameter_value_exception.InvalidParameterValueException: <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
capo_config_service.errors.no_such_remediation_configuration_exception.NoSuchRemediationConfigurationException: <p>You specified an Config rule without a remediation configuration.</p>
capo_config_service.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_config_service.types.describe_remediation_execution_status_request.DescribeRemediationExecutionStatusRequest]",
) -> OperationResponse[
"capo_config_service.types.describe_remediation_execution_status_response.DescribeRemediationExecutionStatusResponse"
]:
import capo_config_service._operations.starling_dove_service.describe_remediation_execution_status
output, http_response = (
capo_config_service._operations.starling_dove_service.describe_remediation_execution_status.describe_remediation_execution_status(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeRemediationExecutionStatus")
)
input_: capo_config_service.types.describe_remediation_execution_status_request.DescribeRemediationExecutionStatusRequest = {
"config_rule_name": config_rule_name
}
if resource_keys is not None:
input_["resource_keys"] = resource_keys
if limit is not None:
input_["limit"] = limit
if next_token is not None:
input_["next_token"] = next_token
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|