upload_portal_api module

UploadPortalApi

class edgeimpulse_api.api.upload_portal_api.UploadPortalApi(
		api_client=None
)

Parameters

  • api_client=None

Methods

edgeimpulse_api.api.upload_portal_api.create_signed_upload_link(
		self,
		portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		create_signed_upload_link_request: edgeimpulse_api.models.create_signed_upload_link_request.CreateSignedUploadLinkRequest,
		**kwargs
)> edgeimpulse_api.models.create_signed_upload_link_response.CreateSignedUploadLinkResponse

Create pre-signed S3 upload link

Creates a signed link to securely upload data to s3 bucket directly from the client.

Parameters

  • self

  • portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]

  • create_signed_upload_link_request: edgeimpulse_api.models.create_signed_upload_link_request.CreateSignedUploadLinkRequest

  • **kwargs

Return

edgeimpulse_api.models.create_signed_upload_link_response.CreateSignedUploadLinkResponse

delete_portal_file

edgeimpulse_api.api.upload_portal_api.delete_portal_file(
		self,
		portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		delete_portal_file_request: edgeimpulse_api.models.delete_portal_file_request.DeletePortalFileRequest,
		**kwargs
)> edgeimpulse_api.models.generic_api_response.GenericApiResponse

Delete file from portal

Delete a file from an upload portal (requires JWT auth).

Parameters

  • self

  • portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]

  • delete_portal_file_request: edgeimpulse_api.models.delete_portal_file_request.DeletePortalFileRequest

  • **kwargs

Return

edgeimpulse_api.models.generic_api_response.GenericApiResponse

download_portal_file

edgeimpulse_api.api.upload_portal_api.download_portal_file(
		self,
		portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],
		download_portal_file_request: edgeimpulse_api.models.download_portal_file_request.DownloadPortalFileRequest,
		**kwargs
)> edgeimpulse_api.models.download_portal_file_response.DownloadPortalFileResponse

Download file from portal

Download a file from an upload portal (requires JWT auth). Will return a signed URL to the bucket.

Parameters

  • self

  • portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})]

  • download_portal_file_request: edgeimpulse_api.models.download_portal_file_request.DownloadPortalFileRequest

  • **kwargs

Return

edgeimpulse_api.models.download_portal_file_response.DownloadPortalFileResponse

get_portal_info

edgeimpulse_api.api.upload_portal_api.get_portal_info(
		self,
		portal_id: typing_extensions.Annotated[pydantic.types.StrictInt, FieldInfo(default=Ellipsis, description='Portal ID', extra={})],