IoTThingsGraph / Client / get_upload_status

get_upload_status#

IoTThingsGraph.Client.get_upload_status(**kwargs)#

Gets the status of the specified upload.

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.

Request Syntax

response = client.get_upload_status(
    uploadId='string'
)

Parameters:

uploadId (string) –

[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'uploadId': 'string',
    'uploadStatus': 'IN_PROGRESS'|'SUCCEEDED'|'FAILED',
    'namespaceArn': 'string',
    'namespaceName': 'string',
    'namespaceVersion': 123,
    'failureReason': [
        'string',
    ],
    'createdDate': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- 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 (integer) –
  
  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 (datetime) –
  
  The date at which the upload was created.

Exceptions

IoTThingsGraph.Client.exceptions.InvalidRequestException
IoTThingsGraph.Client.exceptions.ResourceNotFoundException
IoTThingsGraph.Client.exceptions.InternalFailureException
IoTThingsGraph.Client.exceptions.ThrottlingException