[ aws . iotthingsgraph ]
Gets the status of the specified upload.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
get-upload-status
--upload-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--upload-id
(string)
The ID of the upload. This value is returned by the
UploadEntityDefinitions
action.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To get the status of your entity upload
The following get-upload-status
example gets the status of your entity upload operation. The value of MyUploadId
is the ID value returned by the upload-entity-definitions
operation.
aws iotthingsgraph get-upload-status \
--upload-id "MyUploadId"
Output:
{
"namespaceName": "us-west-2/123456789012/default",
"namespaceVersion": 5,
"uploadId": "f6294f1e-b109-4bbe-9073-f451a2dda2da",
"uploadStatus": "SUCCEEDED"
}
For more information, see Modeling Entities in the AWS IoT Things Graph User Guide.
uploadId -> (string)
The ID of the upload.
uploadStatus -> (string)
The status of the upload. The initial status is
IN_PROGRESS
. The response show all validation failures if the upload fails.
namespaceArn -> (string)
The ARN of the upload.
namespaceName -> (string)
The name of the upload’s namespace.
namespaceVersion -> (long)
The version of the user’s namespace. Defaults to the latest version of the user’s namespace.
failureReason -> (list)
The reason for an upload failure.
(string)
createdDate -> (timestamp)
The date at which the upload was created.