Sign In to the Console
AWS IoT Things Graph
Welcome (API Version 2018-09-06)

AWS Documentation » ThingsGraph » Welcome » Actions » GetUploadStatus
The AWS Documentation website is getting a new look!
Try it now and let us know what you think. Switch to the new look >>

You can return to the original look by selecting English in the language selector above.

GetUploadStatus

Gets the status of the specified upload.

Request Syntax

{
   "uploadId": "string"
}

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.

uploadId

The ID of the upload. This value is returned by the UploadEntityDefinitions action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

Required: Yes

Response Syntax

{
   "createdDate": number,
   "failureReason": [ "string" ],
   "namespaceArn": "string",
   "namespaceName": "string",
   "namespaceVersion": number,
   "uploadId": "string",
   "uploadStatus": "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.

createdDate

The date at which the upload was created.

Type: Timestamp

failureReason

The reason for an upload failure.

Type: Array of strings

namespaceArn

The ARN of the upload.

Type: String

namespaceName

The name of the upload's namespace.

Type: String

Length Constraints: Maximum length of 128.

namespaceVersion

The version of the user's namespace. Defaults to the latest version of the user's namespace.

Type: Long

uploadId

The ID of the upload.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 40.

uploadStatus

The status of the upload. The initial status is IN_PROGRESS. The response show all validation failures if the upload fails.

Type: String

Valid Values: IN_PROGRESS | SUCCEEDED | FAILED

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

ResourceNotFoundException

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: