get_property_value ¶

def get_property_value(
    self,
    selected_properties: "capo_iottwinmaker.types.selected_property_list.SelectedPropertyList",
    workspace_id: "capo_iottwinmaker.types.id.Id",
    *,
    config_overrides: Optional[IoTTwinMakerClientConfig] = None,
    component_name: Optional["capo_iottwinmaker.types.name.Name"] = None,
    component_path: Optional[
        "capo_iottwinmaker.types.component_path.ComponentPath"
    ] = None,
    component_type_id: Optional[
        "capo_iottwinmaker.types.component_type_id.ComponentTypeId"
    ] = None,
    entity_id: Optional["capo_iottwinmaker.types.entity_id.EntityId"] = None,
    max_results: Optional["capo_iottwinmaker.types.max_results.MaxResults"] = None,
    next_token: Optional["capo_iottwinmaker.types.next_token.NextToken"] = None,
    property_group_name: Optional["capo_iottwinmaker.types.name.Name"] = None,
    tabular_conditions: Optional[
        "capo_iottwinmaker.types.tabular_conditions.TabularConditions"
    ] = None,
) -> "capo_iottwinmaker.types.get_property_value_response.GetPropertyValueResponse":
    """<p>Gets the property values for a component, component type, entity, or workspace.</p> <p>You must specify a value for either <code>componentName</code>, <code>componentTypeId</code>, <code>entityId</code>, or <code>workspaceId</code>.</p>

    Args:
        component_name: <p>The name of the component whose property values the operation returns.</p>
        component_path: <p>This string specifies the path to the composite component, starting from the top-level component.</p>
        component_type_id: <p>The ID of the component type whose property values the operation returns.</p>
        entity_id: <p>The ID of the entity whose property values the operation returns.</p>
        selected_properties: <p>The properties whose values the operation returns.</p>
        workspace_id: <p>The ID of the workspace whose values the operation returns.</p>
        max_results: <p>The maximum number of results to return at one time. The default is 25.</p> <p>Valid Range: Minimum value of 1. Maximum value of 250.</p>
        next_token: <p>The string that specifies the next page of results.</p>
        property_group_name: <p>The property group name.</p>
        tabular_conditions: <p>The tabular conditions.</p>

    Raises:
        capo_iottwinmaker.errors.access_denied_exception.AccessDeniedException: <p>Access is denied.</p>
        capo_iottwinmaker.errors.connector_failure_exception.ConnectorFailureException: <p>The connector failed.</p>
        capo_iottwinmaker.errors.connector_timeout_exception.ConnectorTimeoutException: <p>The connector timed out.</p>
        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.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_property_value_request.GetPropertyValueRequest]",
    ) -> OperationResponse[
        "capo_iottwinmaker.types.get_property_value_response.GetPropertyValueResponse"
    ]:
        import capo_iottwinmaker._operations.aws_io_t_twin_maker.get_property_value

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

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetPropertyValue")
    )
    input_: capo_iottwinmaker.types.get_property_value_request.GetPropertyValueRequest = {
        "selected_properties": selected_properties,
        "workspace_id": workspace_id,
    }
    if component_name is not None:
        input_["component_name"] = component_name
    if component_path is not None:
        input_["component_path"] = component_path
    if component_type_id is not None:
        input_["component_type_id"] = component_type_id
    if entity_id is not None:
        input_["entity_id"] = entity_id
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if property_group_name is not None:
        input_["property_group_name"] = property_group_name
    if tabular_conditions is not None:
        input_["tabular_conditions"] = tabular_conditions

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