create_component_type
¶
create_component_type(
workspace_id: Id,
component_type_id: ComponentTypeId,
*,
config_overrides: Optional[IoTTwinMakerClientConfig] = None,
is_singleton: Optional[Boolean] = None,
description: Optional[Description] = None,
property_definitions: Optional[PropertyDefinitionsRequest] = None,
extends_from: Optional[ExtendsFrom] = None,
functions: Optional[FunctionsRequest] = None,
tags: Optional[TagMap] = None,
property_groups: Optional[PropertyGroupsRequest] = None,
component_type_name: Optional[ComponentTypeName] = None,
composite_component_types: Optional[CompositeComponentTypesRequest] = None,
) -> CreateComponentTypeResponse
Creates a component type.
Parameters:
-
workspace_id(Id) –The ID of the workspace that contains the component type.
-
is_singleton(Optional[Boolean], default:None) –A Boolean value that specifies whether an entity can have more than one component of this type.
-
component_type_id(ComponentTypeId) –The ID of the component type.
-
description(Optional[Description], default:None) –The description of the component type.
-
property_definitions(Optional[PropertyDefinitionsRequest], default:None) –An object that maps strings to the property definitions in the component type. Each string in the mapping must be unique to this object.
-
extends_from(Optional[ExtendsFrom], default:None) –Specifies the parent component type to extend.
-
functions(Optional[FunctionsRequest], default:None) –An object that maps strings to the functions in the component type. Each string in the mapping must be unique to this object.
-
tags(Optional[TagMap], default:None) –Metadata that you can use to manage the component type.
-
property_groups(Optional[PropertyGroupsRequest], default:None) – -
component_type_name(Optional[ComponentTypeName], default:None) –A friendly name for the component type.
-
composite_component_types(Optional[CompositeComponentTypesRequest], default:None) –This is an object that maps strings to
compositeComponentTypesof thecomponentType.CompositeComponentTypeis referenced bycomponentTypeId.
Raises:
-
AccessDeniedException–Access is denied.
-
ConflictException–A conflict occurred.
-
InternalServerException–An unexpected error has occurred.
-
ServiceQuotaExceededException–The service quota was exceeded.
-
ThrottlingException–The rate exceeds the limit.
-
ValidationException–Failed
-
UnknownServiceError–The service returned an error code this client does not model.
Source code in docs_src/capo_iottwinmaker/_services/io_t_twin_maker.py
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 | |