organization_allow_developer_profile_api
edgeimpulse_api v1.0.0
edgeimpulse_api.api.organization_allow_developer_profile_api module
class edgeimpulse_api.api.organization_allow_developer_profile_api.OrganizationAllowDeveloperProfileApi(api_client=None)Bases:
object
add_organization_api_key(organization_id: StrictInt, add_organization_api_key_request: AddOrganizationApiKeyRequest, **kwargs)Add API key
Add an API key.
Parameters
organization_id (int) – Organization ID (required)
add_organization_api_key_request (AddOrganizationApiKeyRequest) – (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_deploy_block(organization_id: StrictInt, name: StrictStr, docker_container: StrictStr, description: StrictStr, cli_arguments: StrictStr, requests_cpu: Optional[float] = None, requests_memory: Optional[StrictInt] = None, limits_cpu: Optional[float] = None, limits_memory: Optional[StrictInt] = None, photo: Optional[StrictStr] = None, integrate_url: Optional[StrictStr] = None, privileged: Optional[StrictBool] = None, mount_learn_block: Optional[StrictBool] = None, supports_eon_compiler: Optional[StrictBool] = None, show_optimizations: Optional[StrictBool] = None, category: Optional[StrictStr] = None, **kwargs)Add deploy block
Adds a deploy block.
Parameters
organization_id (int) – Organization ID (required)
name (str) – (required)
docker_container (str) – (required)
description (str) – (required)
cli_arguments (str) – (required)
requests_cpu (float) –
requests_memory (int) –
limits_cpu (float) –
limits_memory (int) –
photo (str) –
integrate_url (str) –
privileged (bool) –
mount_learn_block (bool) –
supports_eon_compiler (bool) –
show_optimizations (bool) –
category (str) –
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_dsp_block(organization_id: StrictInt, add_organization_dsp_block_request: AddOrganizationDspBlockRequest, **kwargs)Add dsp block
Adds a dsp block.
Parameters
organization_id (int) – Organization ID (required)
add_organization_dsp_block_request (AddOrganizationDspBlockRequest) – (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_secret(organization_id: StrictInt, add_organization_secret_request: AddOrganizationSecretRequest, **kwargs)Add secret
Adds a secret.
Parameters
organization_id (int) – Organization ID (required)
add_organization_secret_request (AddOrganizationSecretRequest) – (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_transfer_learning_block(organization_id: StrictInt, add_organization_transfer_learning_block_request: AddOrganizationTransferLearningBlockRequest, **kwargs)Add transfer learning block
Adds a transfer learning block.
Parameters
organization_id (int) – Organization ID (required)
add_organization_transfer_learning_block_request (AddOrganizationTransferLearningBlockRequest) – (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_transformation_block(organization_id: StrictInt, add_organization_transformation_block_request: AddOrganizationTransformationBlockRequest, **kwargs)Add transformation block
Adds a transformation block.
Parameters
organization_id (int) – Organization ID (required)
add_organization_transformation_block_request (AddOrganizationTransformationBlockRequest) – (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
cancel_organization_job(organization_id: StrictInt, job_id: StrictInt, force_cancel: Optional[StrictStr] = None, **kwargs)Cancel job
Cancel a running job.
Parameters
organization_id (int) – Organization ID (required)
job_id (int) – Job ID (required)
force_cancel (str) – If set to ‘true’, we won’t wait for the job cluster to cancel the job, and will mark the job as finished.
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
create_organization(create_organization_request: CreateOrganizationRequest, **kwargs)Create new organization
Create a new organization. This is an internal API.
Parameters
create_organization_request (CreateOrganizationRequest) – (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
create_organization_pipeline(organization_id: StrictInt, organization_update_pipeline_body: OrganizationUpdatePipelineBody, **kwargs)Create pipeline
Create an organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
organization_update_pipeline_body (OrganizationUpdatePipelineBody) – (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_deploy_block(organization_id: StrictInt, deploy_id: StrictInt, **kwargs)Delete deploy block
Deletes a deploy block.
Parameters
organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block 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_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, **kwargs)Delete dsp block
Deletes a dsp block.
Parameters
organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, **kwargs)Delete pipeline
Delete an organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
pipeline_id (int) – Pipeline 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_secret(organization_id: StrictInt, secret_id: StrictInt, **kwargs)Delete transfer learning block
Deletes a transfer learning block.
Parameters
organization_id (int) – Organization ID (required)
secret_id (int) – Secret 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_transfer_learning_block(organization_id: StrictInt, transfer_learning_id: StrictInt, **kwargs)Delete transfer learning block
Deletes a transfer learning block.
Parameters
organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning 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_transformation_block(organization_id: StrictInt, transformation_id: StrictInt, **kwargs)Delete transformation block
Deletes a transformation block.
Parameters
organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block 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
download_organization_jobs_logs(organization_id: StrictInt, job_id: StrictInt, limit: Optional[StrictInt] = None, log_level: Optional[StrictStr] = None, **kwargs)Download logs
Download the logs for a job (as a text file).
Parameters
organization_id (int) – Organization ID (required)
job_id (int) – Job ID (required)
limit (int) – Maximum number of results
log_level (str) – Log level (error, warn, info, debug)
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_info(organization_id: StrictInt, **kwargs)Organization information
List all information about this organization.
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
get_organization_job_status(organization_id: StrictInt, job_id: StrictInt, **kwargs)Get job status
Get the status for a job.
Parameters
organization_id (int) – Organization ID (required)
job_id (int) – Job 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
get_organization_jobs_logs(organization_id: StrictInt, job_id: StrictInt, limit: Optional[StrictInt] = None, log_level: Optional[StrictStr] = None, **kwargs)Get logs
Get the logs for a job.
Parameters
organization_id (int) – Organization ID (required)
job_id (int) – Job ID (required)
limit (int) – Maximum number of results
log_level (str) – Log level (error, warn, info, debug)
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_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, **kwargs)Get pipeline
Retrieve an organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
pipeline_id (int) – Pipeline 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
get_organization_socket_token(organization_id: StrictInt, **kwargs)Get socket token for an organization
Get a token to authenticate with the web socket interface.
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_active_organization_jobs(organization_id: StrictInt, root_only: Optional[StrictBool] = None, **kwargs)List active jobs
Get all active jobs for this organization
Parameters
organization_id (int) – Organization ID (required)
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
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_all_organization_jobs(organization_id: StrictInt, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, exclude_pipeline_transform_jobs: Optional[StrictBool] = None, root_only: Optional[StrictBool] = None, **kwargs)List all jobs
Get all jobs for this organization
Parameters
organization_id (int) – Organization ID (required)
start_date (datetime) – Start date
end_date (datetime) – End date
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
exclude_pipeline_transform_jobs (bool) – Whether to exclude pipeline / transformation jobs
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
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_archived_organization_pipelines(organization_id: StrictInt, project_id: Optional[StrictInt] = None, **kwargs)List archived pipelines
Retrieve all archived organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – If set, filters on pipelines which are attached to this project.
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_finished_organization_jobs(organization_id: StrictInt, start_date: Optional[datetime] = None, end_date: Optional[datetime] = None, limit: Optional[StrictInt] = None, offset: Optional[StrictInt] = None, root_only: Optional[StrictBool] = None, **kwargs)List finished jobs
Get all finished jobs for this organization
Parameters
organization_id (int) – Organization ID (required)
start_date (datetime) – Start date
end_date (datetime) – End date
limit (int) – Maximum number of results
offset (int) – Offset in results, can be used in conjunction with LimitResultsParameter to implement paging.
root_only (bool) – Whether to exclude jobs with a parent ID (so jobs started as part of another job)
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_api_keys(organization_id: StrictInt, **kwargs)Get API keys
Retrieve all API keys. This does not return the full API key, but only a portion (for security purposes).
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_deploy_blocks(organization_id: StrictInt, **kwargs)Get deploy blocks
Retrieve all deploy blocks.
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_dsp_blocks(organization_id: StrictInt, **kwargs)Get dsp blocks
Retrieve all dsp blocks.
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_pipelines(organization_id: StrictInt, project_id: Optional[StrictInt] = None, **kwargs)List pipelines
Retrieve all organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
project_id (int) – If set, filters on pipelines which are attached to this project.
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(organization_id: StrictInt, **kwargs)Get projects
Retrieve all projects for the organization.
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_secrets(organization_id: StrictInt, **kwargs)Get secrets
Retrieve all secrets.
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_transfer_learning_blocks(organization_id: StrictInt, **kwargs)Get transfer learning blocks
Retrieve all transfer learning blocks.
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.
list_organization_transformation_blocks(organization_id: StrictInt, **kwargs)Get transformation blocks
Retrieve all transformation blocks.
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
retry_organization_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, **kwargs)Retry connection to dsp block
Retry launch a dsp block.
Parameters
organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the 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
retry_organization_upload(organization_id: StrictInt, create_project_id: StrictInt, **kwargs)Retry transformation upload job
Retry the upload job from a transformation job. Only jobs that have failed can be retried.
Parameters
organization_id (int) – Organization ID (required)
create_project_id (int) – Create project job 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
revoke_organization_api_key(organization_id: StrictInt, api_key_id: StrictInt, **kwargs)Revoke API key
Revoke an API key.
Parameters
organization_id (int) – Organization ID (required)
api_key_id (int) – API key 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
run_organization_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, ignore_last_successful_run: Optional[StrictBool] = None, **kwargs)Run pipelines
Run an organizational pipeline
Parameters
organization_id (int) – Organization ID (required)
pipeline_id (int) – Pipeline ID (required)
ignore_last_successful_run (bool) – If set then EI_LAST_SUCCESSFUL_RUN is not set. You can use this to re-run a pipeline from scratch.
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_deploy_block(organization_id: StrictInt, deploy_id: StrictInt, name: Optional[StrictStr] = None, docker_container: Optional[StrictStr] = None, description: Optional[StrictStr] = None, cli_arguments: Optional[StrictStr] = None, requests_cpu: Optional[float] = None, requests_memory: Optional[StrictInt] = None, limits_cpu: Optional[float] = None, limits_memory: Optional[StrictInt] = None, photo: Optional[StrictStr] = None, integrate_url: Optional[StrictStr] = None, privileged: Optional[StrictBool] = None, mount_learn_block: Optional[StrictBool] = None, supports_eon_compiler: Optional[StrictBool] = None, show_optimizations: Optional[StrictBool] = None, category: Optional[StrictStr] = None, **kwargs)Update deploy block
Updates a deploy block. Only values in the body will be updated.
Parameters
organization_id (int) – Organization ID (required)
deploy_id (int) – Deploy block ID. (required)
name (str) –
docker_container (str) –
description (str) –
cli_arguments (str) –
requests_cpu (float) –
requests_memory (int) –
limits_cpu (float) –
limits_memory (int) –
photo (str) –
integrate_url (str) –
privileged (bool) –
mount_learn_block (bool) –
supports_eon_compiler (bool) –
show_optimizations (bool) –
category (str) –
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_dsp_block(organization_id: StrictInt, dsp_id: StrictInt, update_organization_dsp_block_request: UpdateOrganizationDspBlockRequest, **kwargs)Update dsp block
Updates a dsp block. Only values in the body will be updated.
Parameters
organization_id (int) – Organization ID (required)
dsp_id (int) – DSP Block ID, use the impulse functions to retrieve the ID (required)
update_organization_dsp_block_request (UpdateOrganizationDspBlockRequest) – (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_pipeline(organization_id: StrictInt, pipeline_id: StrictInt, organization_update_pipeline_body: OrganizationUpdatePipelineBody, **kwargs)Update pipeline
Update an organizational pipelines
Parameters
organization_id (int) – Organization ID (required)
pipeline_id (int) – Pipeline ID (required)
organization_update_pipeline_body (OrganizationUpdatePipelineBody) – (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_transfer_learning_block(organization_id: StrictInt, transfer_learning_id: StrictInt, update_organization_transfer_learning_block_request: UpdateOrganizationTransferLearningBlockRequest, **kwargs)Update transfer learning block
Updates a transfer learning block. Only values in the body will be updated.
Parameters
organization_id (int) – Organization ID (required)
transfer_learning_id (int) – Transfer learning ID (required)
update_organization_transfer_learning_block_request (UpdateOrganizationTransferLearningBlockRequest) – (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_transformation_block(organization_id: StrictInt, transformation_id: StrictInt, update_organization_transformation_block_request: UpdateOrganizationTransformationBlockRequest, **kwargs)Update transformation block
Updates a transformation block. Only values in the body will be updated.
Parameters
organization_id (int) – Organization ID (required)
transformation_id (int) – Transformation block ID. (required)
update_organization_transformation_block_request (UpdateOrganizationTransformationBlockRequest) – (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
upload_custom_block(organization_id: StrictInt, tar: StrictStr, type: StrictStr, block_id: StrictInt, **kwargs)Upload a custom block
Upload a zip file containing a custom transformation or deployment block.
Parameters
organization_id (int) – Organization ID (required)
tar (str) – (required)
type (str) – (required)
block_id (int) – (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?