Skip to content

describe_thing

describe_thing(
    thing_name: ThingName, *, config_overrides: Optional[IoTClientConfig] = None
) -> DescribeThingResponse

Gets information about the specified thing.

Requires permission to access the DescribeThing action.

Parameters:

  • thing_name (ThingName) –

    The name of the thing.

Raises:

Source code in docs_src/capo_iot/_services/io_t.py
def describe_thing(
    self,
    thing_name: "capo_iot.types.thing_name.ThingName",
    *,
    config_overrides: Optional[IoTClientConfig] = None,
) -> "capo_iot.types.describe_thing_response.DescribeThingResponse":
    """<p>Gets information about the specified thing.</p> <p>Requires permission to access the <a href="https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions">DescribeThing</a> action.</p>

    Args:
        thing_name: <p>The name of the thing.</p>

    Raises:
        capo_iot.errors.internal_failure_exception.InternalFailureException: <p>An unexpected error has occurred.</p>
        capo_iot.errors.invalid_request_exception.InvalidRequestException: <p>The request is not valid.</p>
        capo_iot.errors.resource_not_found_exception.ResourceNotFoundException: <p>The specified resource does not exist.</p>
        capo_iot.errors.service_unavailable_exception.ServiceUnavailableException: <p>The service is temporarily unavailable.</p>
        capo_iot.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iot.errors.unauthorized_exception.UnauthorizedException: <p>You are not authorized to perform this operation.</p>
        capo_iot.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iot.types.describe_thing_request.DescribeThingRequest]",
    ) -> OperationResponse[
        "capo_iot.types.describe_thing_response.DescribeThingResponse"
    ]:
        import capo_iot._operations.aws_iot_service.describe_thing

        output, http_response = (
            capo_iot._operations.aws_iot_service.describe_thing.describe_thing(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeThing")
    )
    input_: capo_iot.types.describe_thing_request.DescribeThingRequest = {
        "thing_name": thing_name
    }

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