Skip to content

update_signal_catalog async

update_signal_catalog(
    name: resourceName,
    *,
    config_overrides: Optional[AsyncIoTFleetWiseClientConfig] = None,
    description: Optional[description] = None,
    nodes_to_add: Optional[Nodes] = None,
    nodes_to_update: Optional[Nodes] = None,
    nodes_to_remove: Optional[NodePaths] = None,
) -> UpdateSignalCatalogResponse

Updates a signal catalog.

Parameters:

  • name (resourceName) –

    The name of the signal catalog to update.

  • description (Optional[description], default: None ) –

    A brief description of the signal catalog to update.

  • nodes_to_add (Optional[Nodes], default: None ) –

    A list of information about nodes to add to the signal catalog.

  • nodes_to_update (Optional[Nodes], default: None ) –

    A list of information about nodes to update in the signal catalog.

  • nodes_to_remove (Optional[NodePaths], default: None ) –

    A list of fullyQualifiedName of nodes to remove from the signal catalog.

Raises:

Source code in docs_src/capo_iotfleetwise/_services/async_io_t_fleet_wise.py
async def update_signal_catalog(
    self,
    name: "capo_iotfleetwise.types.resource_name.resourceName",
    *,
    config_overrides: Optional[AsyncIoTFleetWiseClientConfig] = None,
    description: Optional["capo_iotfleetwise.types.description.description"] = None,
    nodes_to_add: Optional["capo_iotfleetwise.types.nodes.Nodes"] = None,
    nodes_to_update: Optional["capo_iotfleetwise.types.nodes.Nodes"] = None,
    nodes_to_remove: Optional[
        "capo_iotfleetwise.types.node_paths.NodePaths"
    ] = None,
) -> "capo_iotfleetwise.types.update_signal_catalog_response.UpdateSignalCatalogResponse":
    """<p> Updates a signal catalog. </p>

    Args:
        name: <p> The name of the signal catalog to update. </p>
        description: <p> A brief description of the signal catalog to update.</p>
        nodes_to_add: <p> A list of information about nodes to add to the signal catalog. </p>
        nodes_to_update: <p> A list of information about nodes to update in the signal catalog. </p>
        nodes_to_remove: <p> A list of <code>fullyQualifiedName</code> of nodes to remove from the signal catalog. </p>

    Raises:
        capo_iotfleetwise.errors.internal_server_exception.InternalServerException: <p>The request couldn't be completed because the server temporarily failed.</p>
        capo_iotfleetwise.errors.access_denied_exception.AccessDeniedException: <p>You don't have sufficient permission to perform this action.</p>
        capo_iotfleetwise.errors.conflict_exception.ConflictException: <p>The request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time.</p>
        capo_iotfleetwise.errors.invalid_node_exception.InvalidNodeException: <p>The specified node type doesn't match the expected node type for a node. You can specify the node type as branch, sensor, actuator, or attribute.</p>
        capo_iotfleetwise.errors.invalid_signals_exception.InvalidSignalsException: <p>The request couldn't be completed because it contains signals that aren't valid.</p>
        capo_iotfleetwise.errors.limit_exceeded_exception.LimitExceededException: <p>A service quota was exceeded. </p>
        capo_iotfleetwise.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource wasn't found.</p>
        capo_iotfleetwise.errors.throttling_exception.ThrottlingException: <p>The request couldn't be completed due to throttling.</p>
        capo_iotfleetwise.errors.validation_exception.ValidationException: <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
        capo_iotfleetwise.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_iotfleetwise.types.update_signal_catalog_request.UpdateSignalCatalogRequest]",
    ) -> AsyncOperationResponse[
        "capo_iotfleetwise.types.update_signal_catalog_response.UpdateSignalCatalogResponse"
    ]:
        import capo_iotfleetwise._operations.io_t_autobahn_control_plane.update_signal_catalog

        (
            output,
            http_response,
        ) = await capo_iotfleetwise._operations.io_t_autobahn_control_plane.update_signal_catalog.async_update_signal_catalog(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("UpdateSignalCatalog")
    )
    input_: capo_iotfleetwise.types.update_signal_catalog_request.UpdateSignalCatalogRequest = {
        "name": name
    }
    if description is not None:
        input_["description"] = description
    if nodes_to_add is not None:
        input_["nodes_to_add"] = nodes_to_add
    if nodes_to_update is not None:
        input_["nodes_to_update"] = nodes_to_update
    if nodes_to_remove is not None:
        input_["nodes_to_remove"] = nodes_to_remove

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output