Skip to content

describe_delivery_channel_status

describe_delivery_channel_status(
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
    delivery_channel_names: Optional[DeliveryChannelNameList] = None,
) -> DescribeDeliveryChannelStatusResponse

Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.

Currently, you can specify only one delivery channel per region in your account.

Parameters:

Raises:

Source code in docs_src/capo_config_service/_services/config_service.py
def describe_delivery_channel_status(
    self,
    *,
    config_overrides: Optional[ConfigServiceClientConfig] = None,
    delivery_channel_names: Optional[
        "capo_config_service.types.delivery_channel_name_list.DeliveryChannelNameList"
    ] = None,
) -> "capo_config_service.types.describe_delivery_channel_status_response.DescribeDeliveryChannelStatusResponse":
    """<p>Returns the current status of the specified delivery channel. If a delivery channel is not specified, this operation returns the current status of all delivery channels associated with the account.</p> <note> <p>Currently, you can specify only one delivery channel per region in your account.</p> </note>

    Args:
        delivery_channel_names: <p>A list of delivery channel names.</p>

    Raises:
        capo_config_service.errors.no_such_delivery_channel_exception.NoSuchDeliveryChannelException: <p>You have specified a delivery channel that does not exist.</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_delivery_channel_status_request.DescribeDeliveryChannelStatusRequest]",
    ) -> OperationResponse[
        "capo_config_service.types.describe_delivery_channel_status_response.DescribeDeliveryChannelStatusResponse"
    ]:
        import capo_config_service._operations.starling_dove_service.describe_delivery_channel_status

        output, http_response = (
            capo_config_service._operations.starling_dove_service.describe_delivery_channel_status.describe_delivery_channel_status(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeDeliveryChannelStatus")
    )
    input_: capo_config_service.types.describe_delivery_channel_status_request.DescribeDeliveryChannelStatusRequest = {}
    if delivery_channel_names is not None:
        input_["delivery_channel_names"] = delivery_channel_names

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