upload_portal_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.upload_portal_api module
class edgeimpulse_api.api.upload_portal_api.UploadPortalApi(api_client=None)Bases:
object
create_signed_upload_link(portal_id: StrictInt, create_signed_upload_link_request: CreateSignedUploadLinkRequest, **kwargs)Create pre-signed S3 upload link
Creates a signed link to securely upload data to s3 bucket directly from the client.
Parameters
portal_id (int) – Portal ID (required)
create_signed_upload_link_request (CreateSignedUploadLinkRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
delete_portal_file(portal_id: StrictInt, delete_portal_file_request: DeletePortalFileRequest, **kwargs)Delete file from portal
Delete a file from an upload portal (requires JWT auth).
Parameters
portal_id (int) – Portal ID (required)
delete_portal_file_request (DeletePortalFileRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
download_portal_file(portal_id: StrictInt, download_portal_file_request: DownloadPortalFileRequest, **kwargs)Download file from portal
Download a file from an upload portal (requires JWT auth). Will return a signed URL to the bucket.
Parameters
portal_id (int) – Portal ID (required)
download_portal_file_request (DownloadPortalFileRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
get_portal_info(portal_id: StrictInt, **kwargs)Portal info
Get information about a portal
Parameters
portal_id (int) – Portal ID (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
list_portal_files_in_folder(portal_id: StrictInt, list_portal_files_in_folder_request: ListPortalFilesInFolderRequest, **kwargs)List files in portal
List all files and directories in specified prefix.
Parameters
portal_id (int) – Portal ID (required)
list_portal_files_in_folder_request (ListPortalFilesInFolderRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
rename_portal_file(portal_id: StrictInt, rename_portal_file_request: RenamePortalFileRequest, **kwargs)Rename file from portal
Rename a file on an upload portal (requires JWT auth).
Parameters
portal_id (int) – Portal ID (required)
rename_portal_file_request (RenamePortalFileRequest) – (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
view_portal_file(portal_id: StrictInt, path: StrictStr, **kwargs)View file from portal
View a file that’s located in an upload portal (requires JWT auth). Will return a signed URL to the bucket.
Parameters
portal_id (int) – Portal ID (required)
path (str) – Path to file in portal (required)
async_req (bool*, *optional) – Whether to execute the request asynchronously.
_preload_content (bool*, *optional) – if False, the urllib3.HTTPResponse object will be returned without reading/decoding response data. Default is True.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
Returns
Returns the result object. If the method is called asynchronously, returns the request thread.
Return type
None
Last updated
Was this helpful?