Skip to content

update_tls_inspection_configuration

update_tls_inspection_configuration(
    tls_inspection_configuration: TLSInspectionConfiguration,
    update_token: UpdateToken,
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    tls_inspection_configuration_arn: Optional[ResourceArn] = None,
    tls_inspection_configuration_name: Optional[ResourceName] = None,
    description: Optional[Description] = None,
    encryption_configuration: Optional[EncryptionConfiguration] = None,
) -> UpdateTLSInspectionConfigurationResponse

Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration.

To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the current TLSInspectionConfiguration object, update the object as needed, and then provide the updated object to this call.

Parameters:

  • tls_inspection_configuration_arn (Optional[ResourceArn], default: None ) –

    The Amazon Resource Name (ARN) of the TLS inspection configuration.

  • tls_inspection_configuration_name (Optional[ResourceName], default: None ) –

    The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.

  • tls_inspection_configuration (TLSInspectionConfiguration) –

    The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

    Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.

    To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Inspecting SSL/TLS traffic with TLS inspection configurations in the Network Firewall Developer Guide.

  • description (Optional[Description], default: None ) –

    A description of the TLS inspection configuration.

  • encryption_configuration (Optional[EncryptionConfiguration], default: None ) –

    A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.

  • update_token (UpdateToken) –

    A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.

    To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.

Raises:

  • InternalServerError –

    Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.

  • InvalidRequestException –

    The operation failed because of a problem with your request. Examples include:

    • You specified an unsupported parameter name or value.

    • You tried to update a property with a value that isn't among the available types.

    • Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.

  • InvalidTokenException –

    The token you provided is stale or isn't valid for the operation.

  • ResourceNotFoundException –

    Unable to locate a resource using the parameters that you provided.

  • ThrottlingException –

    Unable to process the request due to throttling limitations.

  • UnknownServiceError –

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

Source code in docs_src/capo_network_firewall/_services/network_firewall.py
def update_tls_inspection_configuration(
    self,
    tls_inspection_configuration: "capo_network_firewall.types.tls_inspection_configuration.TLSInspectionConfiguration",
    update_token: "capo_network_firewall.types.update_token.UpdateToken",
    *,
    config_overrides: Optional[NetworkFirewallClientConfig] = None,
    tls_inspection_configuration_arn: Optional[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ] = None,
    tls_inspection_configuration_name: Optional[
        "capo_network_firewall.types.resource_name.ResourceName"
    ] = None,
    description: Optional[
        "capo_network_firewall.types.description.Description"
    ] = None,
    encryption_configuration: Optional[
        "capo_network_firewall.types.encryption_configuration.EncryptionConfiguration"
    ] = None,
) -> "capo_network_firewall.types.update_tls_inspection_configuration_response.UpdateTLSInspectionConfigurationResponse":
    """<p>Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by referencing it in one or more firewall policies. When you modify a TLS inspection configuration, you modify all firewall policies that use the TLS inspection configuration. </p> <p>To update a TLS inspection configuration, first call <a>DescribeTLSInspectionConfiguration</a> to retrieve the current <a>TLSInspectionConfiguration</a> object, update the object as needed, and then provide the updated object to this call. </p>

    Args:
        tls_inspection_configuration_arn: <p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>
        tls_inspection_configuration_name: <p>The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.</p>
        tls_inspection_configuration: <p>The object that defines a TLS inspection configuration. This, along with <a>TLSInspectionConfigurationResponse</a>, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling <a>DescribeTLSInspectionConfiguration</a>. </p> <p>Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.</p> <p>To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html">Inspecting SSL/TLS traffic with TLS inspection configurations</a> in the <i>Network Firewall Developer Guide</i>.</p>
        description: <p>A description of the TLS inspection configuration. </p>
        encryption_configuration: <p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.</p>
        update_token: <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request. </p> <p>To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token. </p>

    Raises:
        capo_network_firewall.errors.internal_server_error.InternalServerError: <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request. </p>
        capo_network_firewall.errors.invalid_request_exception.InvalidRequestException: <p>The operation failed because of a problem with your request. Examples include: </p> <ul> <li> <p>You specified an unsupported parameter name or value.</p> </li> <li> <p>You tried to update a property with a value that isn't among the available types.</p> </li> <li> <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p> </li> </ul>
        capo_network_firewall.errors.invalid_token_exception.InvalidTokenException: <p>The token you provided is stale or isn't valid for the operation. </p>
        capo_network_firewall.errors.resource_not_found_exception.ResourceNotFoundException: <p>Unable to locate a resource using the parameters that you provided.</p>
        capo_network_firewall.errors.throttling_exception.ThrottlingException: <p>Unable to process the request due to throttling limitations.</p>
        capo_network_firewall.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_network_firewall.types.update_tls_inspection_configuration_request.UpdateTLSInspectionConfigurationRequest]",
    ) -> OperationResponse[
        "capo_network_firewall.types.update_tls_inspection_configuration_response.UpdateTLSInspectionConfigurationResponse"
    ]:
        import capo_network_firewall._operations.network_firewall_20201112.update_tls_inspection_configuration

        output, http_response = (
            capo_network_firewall._operations.network_firewall_20201112.update_tls_inspection_configuration.update_tls_inspection_configuration(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateTLSInspectionConfiguration")
    )
    input_: capo_network_firewall.types.update_tls_inspection_configuration_request.UpdateTLSInspectionConfigurationRequest = {
        "tls_inspection_configuration": tls_inspection_configuration,
        "update_token": update_token,
    }
    if tls_inspection_configuration_arn is not None:
        input_["tls_inspection_configuration_arn"] = (
            tls_inspection_configuration_arn
        )
    if tls_inspection_configuration_name is not None:
        input_["tls_inspection_configuration_name"] = (
            tls_inspection_configuration_name
        )
    if description is not None:
        input_["description"] = description
    if encryption_configuration is not None:
        input_["encryption_configuration"] = encryption_configuration

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output