UploadEntityDefinitions
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
.
Request Syntax
{
"deprecateExistingEntities": boolean
,
"document": {
"language": "string
",
"text": "string
"
},
"syncWithPublicNamespace": boolean
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- deprecateExistingEntities
-
A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new
DefinitionDocument
. If set totrue
, the upload will create a new namespace version.Type: Boolean
Required: No
- document
-
The
DefinitionDocument
that defines the updated entities.Type: DefinitionDocument object
Required: No
- syncWithPublicNamespace
-
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.Type: Boolean
Required: No
Response Syntax
{
"uploadId": "string"
}
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- uploadId
-
The ID that specifies the upload action. You can use this to track the status of the upload.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalFailureException
-
HTTP Status Code: 500
- InvalidRequestException
-
HTTP Status Code: 400
- ThrottlingException
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: