delete_traffic_mirror_target ¶

delete_traffic_mirror_target(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    traffic_mirror_target_id: Optional[TrafficMirrorTargetId] = None,
    dry_run: Optional[Boolean] = None,
) -> DeleteTrafficMirrorTargetResult

Deletes the specified Traffic Mirror target.

You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.

Parameters:

traffic_mirror_target_id (Optional[TrafficMirrorTargetId], default: None ) –

The ID of the Traffic Mirror target.
dry_run (Optional[Boolean], default: None ) –

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation. Otherwise, it is UnauthorizedOperation.

Raises:

UnknownServiceError –

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

Source code in docs_src/capo_ec2/_services/ec2.py

def delete_traffic_mirror_target(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    traffic_mirror_target_id: Optional[
        "capo_ec2.types.traffic_mirror_target_id.TrafficMirrorTargetId"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
) -> "capo_ec2.types.delete_traffic_mirror_target_result.DeleteTrafficMirrorTargetResult":
    """<p>Deletes the specified Traffic Mirror target.</p> <p>You cannot delete a Traffic Mirror target that is in use by a Traffic Mirror session.</p>

    Args:
        traffic_mirror_target_id: <p>The ID of the Traffic Mirror target.</p>
        dry_run: <p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.delete_traffic_mirror_target_request.DeleteTrafficMirrorTargetRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.delete_traffic_mirror_target_result.DeleteTrafficMirrorTargetResult"
    ]:
        import capo_ec2._operations.amazon_ec2.delete_traffic_mirror_target

        output, http_response = (
            capo_ec2._operations.amazon_ec2.delete_traffic_mirror_target.delete_traffic_mirror_target(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteTrafficMirrorTarget")
    )
    input_: capo_ec2.types.delete_traffic_mirror_target_request.DeleteTrafficMirrorTargetRequest = {}
    if traffic_mirror_target_id is not None:
        input_["traffic_mirror_target_id"] = traffic_mirror_target_id
    if dry_run is not None:
        input_["dry_run"] = dry_run

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