Skip to content

get_traffic_policy

get_traffic_policy(
    traffic_policy_id: TrafficPolicyId,
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
) -> GetTrafficPolicyResponse

Fetch attributes of a traffic policy resource.

Parameters:

  • traffic_policy_id (TrafficPolicyId) –

    The identifier of the traffic policy resource.

Raises:

Examples:

Get TrafficPolicy

>>> client.get_traffic_policy(traffic_policy_id='tp-12345')
Source code in docs_src/capo_mailmanager/_services/mail_manager.py
def get_traffic_policy(
    self,
    traffic_policy_id: "capo_mailmanager.types.traffic_policy_id.TrafficPolicyId",
    *,
    config_overrides: Optional[MailManagerClientConfig] = None,
) -> "capo_mailmanager.types.get_traffic_policy_response.GetTrafficPolicyResponse":
    """<p>Fetch attributes of a traffic policy resource.</p>

    Args:
        traffic_policy_id: <p>The identifier of the traffic policy resource.</p>

    Raises:
        capo_mailmanager.errors.resource_not_found_exception.ResourceNotFoundException: <p>Occurs when a requested resource is not found.</p>
        capo_mailmanager.errors.validation_exception.ValidationException: <p>The request validation has failed. For details, see the accompanying error message.</p>
        capo_mailmanager.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get TrafficPolicy

        >>> client.get_traffic_policy(traffic_policy_id='tp-12345')
    """

    def _handler(
        req: "OperationRequest[capo_mailmanager.types.get_traffic_policy_request.GetTrafficPolicyRequest]",
    ) -> OperationResponse[
        "capo_mailmanager.types.get_traffic_policy_response.GetTrafficPolicyResponse"
    ]:
        import capo_mailmanager._operations.mail_manager_svc.get_traffic_policy

        output, http_response = (
            capo_mailmanager._operations.mail_manager_svc.get_traffic_policy.get_traffic_policy(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetTrafficPolicy")
    )
    input_: capo_mailmanager.types.get_traffic_policy_request.GetTrafficPolicyRequest = {
        "traffic_policy_id": traffic_policy_id
    }

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