AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Set-IOTTGEntityDefinition-Document_Text <String>-DeprecateExistingEntity <Boolean>-Document_Language <DefinitionLanguage>-SyncWithPublicNamespace <Boolean>-Select <String>-PassThru <SwitchParameter>-Force <SwitchParameter>
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
. DefinitionDocument
. If set to true
, the upload will create a new namespace version. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | DeprecateExistingEntities |
GRAPHQL
is the only valid value. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | 1 |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
true
, the upload will create a new namespace version. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z