Skip to content

get_entity

get_entity(
    workspace_id: Id,
    entity_id: EntityId,
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
) -> GetEntityResponse

Retrieves information about an entity.

Parameters:

  • workspace_id (Id) –

    The ID of the workspace.

  • entity_id (EntityId) –

    The ID of the entity.

Raises:

Source code in docs_src/capo_iottwinmaker/_services/io_t_twin_maker.py
def get_entity(
    self,
    workspace_id: "capo_iottwinmaker.types.id.Id",
    entity_id: "capo_iottwinmaker.types.entity_id.EntityId",
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
) -> "capo_iottwinmaker.types.get_entity_response.GetEntityResponse":
    """<p>Retrieves information about an entity.</p>

    Args:
        workspace_id: <p>The ID of the workspace.</p>
        entity_id: <p>The ID of the entity.</p>

    Raises:
        capo_iottwinmaker.errors.internal_server_exception.InternalServerException: <p>An unexpected error has occurred.</p>
        capo_iottwinmaker.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
        capo_iottwinmaker.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The service quota was exceeded.</p>
        capo_iottwinmaker.errors.throttling_exception.ThrottlingException: <p>The rate exceeds the limit.</p>
        capo_iottwinmaker.errors.validation_exception.ValidationException: <p>Failed</p>
        capo_iottwinmaker.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_iottwinmaker.types.get_entity_request.GetEntityRequest]",
    ) -> OperationResponse[
        "capo_iottwinmaker.types.get_entity_response.GetEntityResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.get_entity

        output, http_response = (
            capo_iottwinmaker._operations.aws_io_t_twin_maker.get_entity.get_entity(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetEntity")
    )
    input_: capo_iottwinmaker.types.get_entity_request.GetEntityRequest = {
        "workspace_id": workspace_id,
        "entity_id": entity_id,
    }

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