organization_data_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.organization_data_api module
class edgeimpulse_api.api.organization_data_api.OrganizationDataApi(api_client=None)Bases:
object
add_organization_bucket(organization_id: StrictInt, add_organization_bucket_request: AddOrganizationBucketRequest, **kwargs)Add a storage bucket
Add a storage bucket.
Parameters
organization_id (int) – Organization ID (required)
add_organization_bucket_request (AddOrganizationBucketRequest) – (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
add_organization_data_file(organization_id: StrictInt, data_id: StrictInt, files: List[StrictBytes], **kwargs)Add files
Add a new file to an existing data item.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
files (List*[str]*) – (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
add_organization_data_folder(organization_id: StrictInt, organization_add_data_folder_request: OrganizationAddDataFolderRequest, **kwargs)Add data items from bucket
Bulk adds data items that already exist in a storage bucket. The bucket path specified should contain folders. Each folder is added as a data item in Edge Impulse.
Parameters
organization_id (int) – Organization ID (required)
organization_add_data_folder_request (OrganizationAddDataFolderRequest) – (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
add_organization_data_item(organization_id: StrictInt, name: StrictStr, dataset: StrictStr, metadata: StrictStr, files: List[StrictBytes], bucket_id: Optional[StrictInt] = None, bucket_name: Optional[StrictStr] = None, bucket_path: Optional[StrictStr] = None, **kwargs)Add new data
Add a new data item. You can add a maximum of 10000 files directly through this API. Use addOrganizationDataFile to add additional files.
Parameters
organization_id (int) – Organization ID (required)
name (str) – (required)
dataset (str) – (required)
metadata (str) – Key-value pair of metadata (in JSON format) (required)
files (List*[str]*) – (required)
bucket_id (int) –
bucket_name (str) – Name of the bucket name (as an Edge Impulse name)
bucket_path (str) – Optional path in the bucket to create this data item (files are created under this path).
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
change_dataset_organization_data_items(organization_id: StrictInt, data_ids: StrictStr, set_organization_data_dataset_request: SetOrganizationDataDatasetRequest, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, **kwargs)Change dataset
Change the dataset for selected data items.
Parameters
organization_id (int) – Organization ID (required)
data_ids (str) – Data IDs as an Array (required)
set_organization_data_dataset_request (SetOrganizationDataDatasetRequest) – (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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
clear_checklist_organization_data_items(organization_id: StrictInt, data_ids: StrictStr, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, **kwargs)Clear checklist for data
Clear all checklist flags for selected data items.
Parameters
organization_id (int) – Organization ID (required)
data_ids (str) – Data IDs as an Array (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)Delete file
Delete a single file from a data item.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
file_name (str) – File name (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_organization_data_item(organization_id: StrictInt, data_id: StrictInt, **kwargs)Delete data
Delete a data item. This does not remove the items from the underlying storage.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data 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
delete_organization_data_items(organization_id: StrictInt, data_ids: StrictStr, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, **kwargs)Delete data
Delete all data for selected data items. This removes all data in the underlying data bucket.
Parameters
organization_id (int) – Organization ID (required)
data_ids (str) – Data IDs as an Array (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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_organization_projects_data(organization_id: StrictInt, project_id: Optional[StrictInt] = None, ids: Optional[StrictStr] = None, **kwargs)Delete projects data
Delete data samples from organizational projects.
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – Unique identifier of the organizational project from where data samples will be fetched.
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
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_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)Download file
Download a single file from a data item.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
file_name (str) – File name (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
str
download_organization_data_item(organization_id: StrictInt, data_ids: StrictStr, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, **kwargs)Download data
Download all data for selected data items. This function does not query the underlying bucket.
Parameters
organization_id (int) – Organization ID (required)
data_ids (str) – Data IDs as an Array (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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
str
download_organization_projects_data(organization_id: StrictInt, project_id: Optional[StrictInt] = None, ids: Optional[StrictStr] = None, **kwargs)Download data
Download all selected project data items.
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – Unique identifier of the organizational project from where data samples will be fetched.
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
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
str
download_organization_single_data_item(organization_id: StrictInt, data_id: StrictInt, filter: Optional[StrictStr] = None, **kwargs)Download data
Download all data for this data item.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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
str
get_organization_data_item(organization_id: StrictInt, data_id: StrictInt, filter: Optional[StrictStr] = None, **kwargs)Get data metadata
Get a data item. This will HEAD the underlying bucket to retrieve the last file information.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
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_organization_dataset(organization_id: StrictInt, dataset: StrictStr, **kwargs)Get dataset
Get information about a dataset
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Dataset name (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_organization_projects_data_count(organization_id: StrictInt, project_id: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, **kwargs)Get projects data count
Get the number of samples for all or for a specific organization project.
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – Unique identifier of the organizational project from where data samples will be fetched.
filter (str) – Data filter in SQL WHERE format, where you can reference ‘filename’, ‘label’, ‘project_name’, ‘category’, ‘sensors’, ‘frequency’, and any metadata through ‘metadata->’ (dots are replaced by underscore).
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
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
hide_organization_dataset(organization_id: StrictInt, dataset: StrictStr, **kwargs)Hide dataset
Hide a dataset (does not remove underlying data)
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Dataset name (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_organization_buckets(organization_id: StrictInt, **kwargs)List storage buckets
Retrieve all configured storage buckets. This does not list the secret key.
Parameters
organization_id (int) – Organization 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_organization_data(organization_id: StrictInt, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, **kwargs)List data
Lists all data items. This can be filtered by the ?filter parameter.
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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_organization_files(organization_id: StrictInt, dataset: Optional[StrictStr] = None, filter: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, **kwargs)List files
Lists all files included by the filter.
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Selected dataset
filter (str) – Data filter in SQL WHERE format, where you can reference ‘dataset’, ‘bucket’, ‘name’, ‘total_file_count’, ‘total_file_size’, ‘created’ and any metadata label through ‘metadata->’ (dots are replaced by underscore).
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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_organization_projects_data(organization_id: StrictInt, project_id: Optional[StrictInt] = None, filter: Optional[StrictStr] = None, ids: Optional[StrictStr] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, **kwargs)Get projects data
Retrieve all the data samples from organizational projects.
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – Unique identifier of the organizational project from where data samples will be fetched.
filter (str) – Data filter in SQL WHERE format, where you can reference ‘filename’, ‘label’, ‘project_name’, ‘category’, ‘sensors’, ‘frequency’, and any metadata through ‘metadata->’ (dots are replaced by underscore).
ids (str) – Only include samples with an ID within the given list of IDs, given as a JSON string
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
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
organization_bulk_update_metadata(organization_id: StrictInt, dataset: StrictStr, csv_file: StrictStr, **kwargs)Bulk update metadata
Bulk update the metadata of many data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named ‘name’. The other columns are used as metadata keys.
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – (required)
csv_file (str) – (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
organization_projects_data_batch_disable(organization_id: StrictInt, organization_projects_data_batch_request: OrganizationProjectsDataBatchRequest, **kwargs)Batch disable data
Batch disable project data samples by dataId
Parameters
organization_id (int) – Organization ID (required)
organization_projects_data_batch_request (OrganizationProjectsDataBatchRequest) – (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
organization_projects_data_batch_enable(organization_id: StrictInt, organization_projects_data_batch_request: OrganizationProjectsDataBatchRequest, **kwargs)Batch enable data
Batch enable project data samples by dataId
Parameters
organization_id (int) – Organization ID (required)
organization_projects_data_batch_request (OrganizationProjectsDataBatchRequest) – (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
organization_projects_data_bulk_update_metadata(organization_id: StrictInt, csv_file: StrictStr, project_ids: Optional[List[StrictInt]] = None, **kwargs)Bulk update metadata
Bulk update the metadata of many raw data items in one go. This requires you to submit a CSV file with headers, one of which the columns should be named ‘name’. The other columns are used as metadata keys.
Parameters
organization_id (int) – Organization ID (required)
csv_file (str) – (required)
project_ids (List*[int]*) –
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
preview_organization_data_file(organization_id: StrictInt, data_id: StrictInt, file_name: StrictStr, **kwargs)Preview file
Preview a single file from a data item (same as downloadOrganizationDataFile but w/ content-disposition inline).
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
file_name (str) – File name (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
str
refresh_organization_data(organization_id: StrictInt, dataset: Optional[StrictStr] = None, **kwargs)Refresh data
Update all data items. HEADs all underlying buckets to retrieve the last file information. Use this API after uploading data directly to S3.
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Selected dataset
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
remove_organization_bucket(organization_id: StrictInt, bucket_id: StrictInt, **kwargs)Remove storage bucket
Remove a storage bucket. This will render any data in this storage bucket unreachable.
Parameters
organization_id (int) – Organization ID (required)
bucket_id (int) – Bucket 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
update_organization_bucket(organization_id: StrictInt, bucket_id: StrictInt, update_organization_bucket_request: UpdateOrganizationBucketRequest, **kwargs)Update storage bucket
Updates storage bucket details. This only updates fields that were set in the request body.
Parameters
organization_id (int) – Organization ID (required)
bucket_id (int) – Bucket ID (required)
update_organization_bucket_request (UpdateOrganizationBucketRequest) – (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
update_organization_data_item(organization_id: StrictInt, data_id: StrictInt, update_organization_data_item_request: UpdateOrganizationDataItemRequest, **kwargs)Update data metadata
Update the data item metadata.
Parameters
organization_id (int) – Organization ID (required)
data_id (int) – Data ID (required)
update_organization_data_item_request (UpdateOrganizationDataItemRequest) – (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
update_organization_dataset(organization_id: StrictInt, dataset: StrictStr, update_organization_dataset_request: UpdateOrganizationDatasetRequest, **kwargs)Update dataset
Set information about a dataset
Parameters
organization_id (int) – Organization ID (required)
dataset (str) – Dataset name (required)
update_organization_dataset_request (UpdateOrganizationDatasetRequest) – (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
verify_organization_bucket(organization_id: StrictInt, verify_organization_bucket_request: VerifyOrganizationBucketRequest, **kwargs)Verify bucket connectivity
Verify whether we can reach a bucket before adding it.
Parameters
organization_id (int) – Organization ID (required)
verify_organization_bucket_request (VerifyOrganizationBucketRequest) – (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
Last updated
Was this helpful?