Skip to content

update_security_control async

update_security_control(
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    security_control_id: Optional[NonEmptyString] = None,
    parameters: Optional[Parameters] = None,
    last_update_reason: Optional[AlphaNumericNonEmptyString] = None,
) -> UpdateSecurityControlResponse

Updates the properties of a security control.

Parameters:

  • security_control_id (Optional[NonEmptyString], default: None ) –

    The Amazon Resource Name (ARN) or ID of the control to update.

  • parameters (Optional[Parameters], default: None ) –

    An object that specifies which security control parameters to update.

  • last_update_reason (Optional[AlphaNumericNonEmptyString], default: None ) –

    The most recent reason for updating the properties of the security control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores.

Raises:

  • AccessDeniedException –

    You don't have permission to perform the action specified in the request.

  • InternalException –

    Internal server error.

  • InvalidAccessException –

    The account doesn't have permission to perform this action.

  • InvalidInputException –

    The request was rejected because you supplied an invalid or out-of-range value for an input parameter.

  • LimitExceededException –

    The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.

  • ResourceInUseException –

    The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the UPDATING state.

  • ResourceNotFoundException –

    The request was rejected because we can't find the specified resource.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

To update security control properties The following example updates the specified security control. Specifically, this example updates control parameters.

>>> await client.update_security_control(security_control_id='ACM.1', parameters={'maxCredentialUsageAge': {'ValueType': 'CUSTOM', 'Value': {'Integer': 15}}}, last_update_reason='Comply with internal requirements')
Source code in docs_src/capo_securityhub/_services/async_security_hub.py
async def update_security_control(
    self,
    *,
    config_overrides: Optional[AsyncSecurityHubClientConfig] = None,
    security_control_id: Optional[
        "capo_securityhub.types.non_empty_string.NonEmptyString"
    ] = None,
    parameters: Optional["capo_securityhub.types.parameters.Parameters"] = None,
    last_update_reason: Optional[
        "capo_securityhub.types.alpha_numeric_non_empty_string.AlphaNumericNonEmptyString"
    ] = None,
) -> "capo_securityhub.types.update_security_control_response.UpdateSecurityControlResponse":
    """<p> Updates the properties of a security control. </p>

    Args:
        security_control_id: <p> The Amazon Resource Name (ARN) or ID of the control to update. </p>
        parameters: <p> An object that specifies which security control parameters to update. </p>
        last_update_reason: <p> The most recent reason for updating the properties of the security control. This field accepts alphanumeric characters in addition to white spaces, dashes, and underscores. </p>

    Raises:
        capo_securityhub.errors.access_denied_exception.AccessDeniedException: <p>You don't have permission to perform the action specified in the request.</p>
        capo_securityhub.errors.internal_exception.InternalException: <p>Internal server error.</p>
        capo_securityhub.errors.invalid_access_exception.InvalidAccessException: <p>The account doesn't have permission to perform this action.</p>
        capo_securityhub.errors.invalid_input_exception.InvalidInputException: <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
        capo_securityhub.errors.limit_exceeded_exception.LimitExceededException: <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
        capo_securityhub.errors.resource_in_use_exception.ResourceInUseException: <p> The request was rejected because it conflicts with the resource's availability. For example, you tried to update a security control that's currently in the <code>UPDATING</code> state. </p>
        capo_securityhub.errors.resource_not_found_exception.ResourceNotFoundException: <p>The request was rejected because we can't find the specified resource.</p>
        capo_securityhub.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To update security control properties
        The following example updates the specified security control. Specifically, this example updates control parameters.

        >>> await client.update_security_control(security_control_id='ACM.1', parameters={'maxCredentialUsageAge': {'ValueType': 'CUSTOM', 'Value': {'Integer': 15}}}, last_update_reason='Comply with internal requirements')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_securityhub.types.update_security_control_request.UpdateSecurityControlRequest]",
    ) -> AsyncOperationResponse[
        "capo_securityhub.types.update_security_control_response.UpdateSecurityControlResponse"
    ]:
        import capo_securityhub._operations.security_hub_api_service.update_security_control

        (
            output,
            http_response,
        ) = await capo_securityhub._operations.security_hub_api_service.update_security_control.async_update_security_control(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSecurityControl")
    )
    input_: capo_securityhub.types.update_security_control_request.UpdateSecurityControlRequest = {}
    if security_control_id is not None:
        input_["security_control_id"] = security_control_id
    if parameters is not None:
        input_["parameters"] = parameters
    if last_update_reason is not None:
        input_["last_update_reason"] = last_update_reason

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output