IoTThingsGraph / Client / upload_entity_definitions

upload_entity_definitions#

IoTThingsGraph.Client.upload_entity_definitions(**kwargs)#

Asynchronously uploads one or more entity definitions to the user’s namespace. The document parameter is required if syncWithPublicNamespace and deleteExistingEntites are false. If the syncWithPublicNamespace parameter is set to true, the user’s namespace will synchronize with the latest version of the public namespace. If deprecateExistingEntities is set to true, all entities in the latest version will be deleted before the new DefinitionDocument is uploaded.

When a user uploads entity definitions for the first time, the service creates a new namespace for the user. The new namespace tracks the public namespace. Currently users can have only one namespace. The namespace version increments whenever a user uploads entity definitions that are backwards-incompatible and whenever a user sets the syncWithPublicNamespace parameter or the deprecateExistingEntities parameter to true.

The IDs for all of the entities should be in URN format. Each entity must be in the user’s namespace. Users can’t create entities in the public namespace, but entity definitions can refer to entities in the public namespace.

Valid entities are Device, DeviceModel, Service, Capability, State, Action, Event, Property, Mapping, Enum.

Danger

This operation is deprecated and may not function as expected. This operation should not be used going forward and is only kept for the purpose of backwards compatiblity.

See also: AWS API Documentation

Request Syntax

response = client.upload_entity_definitions(
    document={
        'language': 'GRAPHQL',
        'text': 'string'
    },
    syncWithPublicNamespace=True|False,
    deprecateExistingEntities=True|False
)
Parameters:

  • document (dict) –

    The DefinitionDocument that defines the updated entities.

    • language (string) – [REQUIRED]

      The language used to define the entity. GRAPHQL is the only valid value.

    • text (string) – [REQUIRED]

      The GraphQL text that defines the entity.

  • syncWithPublicNamespace (boolean) – A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

  • deprecateExistingEntities (boolean) – A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

Return type:

dict

Returns:

Response Syntax

{
    'uploadId': 'string'
}

Response Structure

  • (dict) –

    • uploadId (string) –

      The ID that specifies the upload action. You can use this to track the status of the upload.

Exceptions

  • IoTThingsGraph.Client.exceptions.InvalidRequestException

  • IoTThingsGraph.Client.exceptions.InternalFailureException

  • IoTThingsGraph.Client.exceptions.ThrottlingException