Skip to content

describe_input

describe_input(
    input_name: InputName, *, config_overrides: Optional[IoTEventsClientConfig] = None
) -> DescribeInputResponse

Describes an input.

Parameters:

  • input_name (InputName) –

    The name of the input.

Raises:

Source code in docs_src/capo_iot_events/_services/io_t_events.py
def describe_input(
    self,
    input_name: "capo_iot_events.types.input_name.InputName",
    *,
    config_overrides: Optional[IoTEventsClientConfig] = None,
) -> "capo_iot_events.types.describe_input_response.DescribeInputResponse":
    """<p>Describes an input.</p>

    Args:
        input_name: <p>The name of the input.</p>

    Raises:
        capo_iot_events.errors.internal_failure_exception.InternalFailureException: <p>An internal failure occurred.</p>
        capo_iot_events.errors.invalid_request_exception.InvalidRequestException: <p>The request was invalid.</p>
        capo_iot_events.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource was not found.</p>
        capo_iot_events.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is currently unavailable.</p>
        capo_iot_events.errors.throttling_exception.ThrottlingException: <p>The request could not be completed due to throttling.</p>
        capo_iot_events.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot_events.types.describe_input_request.DescribeInputRequest]",
    ) -> OperationResponse[
        "capo_iot_events.types.describe_input_response.DescribeInputResponse"
    ]:
        import capo_iot_events._operations.iot_columbo_service.describe_input

        output, http_response = (
            capo_iot_events._operations.iot_columbo_service.describe_input.describe_input(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeInput")
    )
    input_: capo_iot_events.types.describe_input_request.DescribeInputRequest = {
        "input_name": input_name
    }

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