integrateddatalake.clients package

Submodules

integrateddatalake.clients.object_access_operations_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class ObjectAccessOperationsClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

create_cross_account(request_object)[source]

Create a cross account

Create a cross account on which access needs to be given for paths. * If, in request body subtenant is denoted as “**”, it is a special cross account. In this case, on this cross account, tenant implicitly gets Read Only access to the storage account’s root level data path for itself and for all its subtenants. For this case, the authorization token should be that of the tenant.

Parameters:request_object (CreateCrossAccountRequest) – It contains the below parameters –>
( crossAccountRequest* - Cross Account Request )
Returns:CrossAccount
create_cross_account_access(request_object)[source]

Create a cross account access

Create a cross account access. If the cross account is created for tenant and all subtenants (**), then this operation is implicitly handled and not allowed through API. Maximum 5 cross account accesses can be created with ENABLED status. Maximum 10 cross accounts can be created with DISABLED status.

Parameters:request_object (CreateCrossAccountAccessRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( crossAccountAccessRequest* - Cross Account Access Request )
Returns:CrossAccountAccess
delete_cross_account(request_object)[source]

Delete cross account and corresponding accesses.

Delete cross account and corresponding accesses.

Parameters:request_object (DeleteCrossAccountRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( If-Match* - ETag of the resource )
Returns:None
delete_cross_account_access(request_object)[source]

Delete a cross account access.

Delete a cross account access. If the cross account is created for tenant and all subtenants (**), then this operation is implicitly handled by deletion of cross account and not allowed through API

Parameters:request_object (DeleteCrossAccountAccessRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( accessId* - unique identifier of the cross account ),
( If-Match* - ETag of the resource )
Returns:None
generate_download_object_urls(request_object)[source]

Generate signed URLs to download for single object.

Generate signed URLs to download for single object.

Parameters:request_object (GenerateDownloadObjectUrlsRequest) – It contains the below parameters –>
( generateUrlPayload - download payload with path details array and optional subtenat id )
Returns:SignedUrlResponse
generate_upload_object_urls(request_object)[source]

Generate signed URLs to upload an object.

Generate signed URLs to upload one or more objects.

Parameters:request_object (GenerateUploadObjectUrlsRequest) – It contains the below parameters –>
( generateUrlPayload - upload payload with path details array and optional subtenat id )
Returns:SignedUrlResponse
get_cross_account(request_object)[source]

Get details of selected cross account

Get details of selected cross account.

Parameters:request_object (GetCrossAccountRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account )
Returns:CrossAccount
get_cross_account_access(request_object)[source]

Get a selected access for a selected cross account

Get a selected access for a selected cross account.

Parameters:request_object (GetCrossAccountAccessRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( accessId* - unique identifier of the cross account access )
Returns:CrossAccountAccess
list_cross_account(request_object)[source]

Get a list of cross accounts

Get list of cross accounts on which access was given. * If requester is tenant, all the cross account for the tenant as well as its all subtenants are returned. * If requester is a subtenant, all the cross accounts for the subtenant are returned. * If tenant wants to filter results for a particular subtenant, filter query parameter subtenantId can be used. This filter query parameter is applicable only if the requester is tenant.

Parameters:request_object (ListCrossAccountRequest) – It contains the below parameters –>
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page ),
( filter - JSON-based filter expression. Supported values: ‘subtenantId’. Supported operations: ‘eq’. Decoded example value: { “subtenantId”: “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4” } )
Returns:CrossAccountListResource
list_cross_account_access(request_object)[source]

Get a list of cross account accesses

Get list of cross account accesses.

Parameters:request_object (ListCrossAccountAccessRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page )
Returns:CrossAccountAccessListResource
update_cross_account(request_object)[source]

Update a cross account

Update a cross account on which access needs to be managed.

Parameters:request_object (UpdateCrossAccountRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( If-Match* - ETag of the resource ),
( crossAccountRequest* - Cross Account Request )
Returns:CrossAccount
update_cross_account_access(request_object)[source]

Update a cross account access

Update a cross account access. This operation is not allowed when the cross account is created for special case of tenant and all subtenants (**). Maximum 5 cross account accesses can be present with ENABLED status. Maximum 10 cross accounts can be present with DISABLED status.

Parameters:request_object (UpdateCrossAccountAccessRequest) – It contains the below parameters –>
( id* - unique identifier of the cross account ),
( accessId* - unique identifier of the cross account access ),
( If-Match* - ETag of the resource ),
( crossAccountAccessRequest* - Cross Account Access Request )
Returns:CrossAccountAccess

integrateddatalake.clients.object_event_subscription_operations_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class ObjectEventSubscriptionOperationsClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

create_object_event_subscription(request_object)[source]

Create object event subscription.

Allows users to subscribe for event notifications generated when the objects of a tenant or subtenant are created, updated, or deleted. Multiple subscriptions for the same path can be created when each has a different destination. Similarly, multiple subscriptions for the same destination can be created when each has a different path. Maximum 15 subscriptions can be created for a tenant or for a subtenant. Path in request payload should be upto folders and not upto object e.g. “myfolder/mysubfolder” ### Notification Content Based on the configured subscriptions, event notification messages are published to the destination. The event notification content is formatted in JSON according to this example. If object operation happened in subtenant folder, both tenantId and subtenantId will be part of the message. If object operation happened in tenant folder, only tenantId will be part of the message.: { “path” : “/myfolder/mysubfolder/myobj.ext”, “storageAccount” : “dlbucketname”, “storagePath” : “/data/ten=mytenid/myfolder/mysubfolder/myobj.ext” “tenantId” : “mytenid”, “subtenantId” : “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4” “eventType” : “MODIFY”, “timestamp” : “2019-05-17T14:47:44.351Z” } where - ‘path’ path applicable for supplying to Data Lake APIs like /objectMetadata - ‘storageAccount’ Bucket name in case of AWS S3 - ‘storagePath’ Complete S3 prefix path including the object name. Clients should not rely on a given path structure, but should treat storagePath as opaque. - ‘tenantId’ Tenant Id on whose bucket the object operation happened, resulting in notification message - ‘subtenantId’ Optional. Subtenant Id, in case the object operation happened for a subtenant, resuling in notification message - ‘eventType’ is either ‘MODIFY’ in case of creation or update, and ‘DELETE’ in case of object deletion. - ‘timestamp’ records the time when the event happened. It is formatted according to ISO 8601 extended date/time format ‘YYYY-MM-DDThh:mm:ss.sssZ’.
Parameters:request_object (CreateObjectEventSubscriptionRequest) – It contains the below parameters –>
( subscription* - object event subscrition details )
Returns:SubscriptionResponse
delete_object_event_subscription(request_object)[source]

Delete object event subscription by id.

Delete object event subscription (Unsubscribe).

Parameters:request_object (DeleteObjectEventSubscriptionRequest) – It contains the below parameters –>
( id* - unique identifier of the subscription ),
( If-Match* - ETag of the resource )
Returns:None
patch_object_event_subscription(request_object)[source]

Update object event subscription by id.

Update object event subscription.

Parameters:request_object (PatchObjectEventSubscriptionRequest) – It contains the below parameters –>
( id* - unique identifier of the subscription ),
( If-Match* - ETag of the resource ),
( subscription* - object event subscrition details )
Returns:SubscriptionResponse
query_object_event_subscriptions(request_object)[source]

List event subscriptions for the tenant or subtenant.

List object event subscriptions for the tenant or subtenant. If requester is tenant, all the subscriptions for the tenant as well as its all subtenants are returned. If requester is a subtenant, all the subscriptions for the subtenant are returned. If tenant wants to filter results for a particular subtenant, filter query parameter subtenantId can be used. This filter query parameter is applicable only if the requester is tenant.

Parameters:request_object (QueryObjectEventSubscriptionsRequest) – It contains the below parameters –>
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page ),
( filter - JSON-based filter expression. Supported values: ‘subtenantId’. Supported operations: ‘eq’. Decoded example value: { “subtenantId”: “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4” } )
Returns:SubscriptionListResource
retrieve_object_event_subscription(request_object)[source]

Read object event subscription by id.

Read object event subscription for the tenant.

Parameters:request_object (RetrieveObjectEventSubscriptionRequest) – It contains the below parameters –>
( id* - unique identifier of the subscrition )
Returns:SubscriptionResponse

integrateddatalake.clients.object_operations_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class ObjectOperationsClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

create_delete_objects_job(request_object)[source]

Delete multiple objects in bulk.

Create asynchronous job to delete multiple objects for the specified paths. If any of the given paths doesn’t exist then job will return status as COMPLETED_WITH_ERRORS. <br/><br/>Jobs which are completed with or without errors would be deleted periodically. <br/><br/>Data once deleted cannot be recovered.

Parameters:request_object (CreateDeleteObjectsJobRequest) – It contains the below parameters –>
( DeleteObjectsJob* - Delete Objects Job )
Returns:DeleteObjectsJobResponse
delete_object(request_object)[source]

delete an object.

Delete the object for the specified path.

Parameters:request_object (DeleteObjectRequest) – It contains the below parameters –>
( path* - path of an object denoting folders and object name. e.g. basefolder/subfolder/objectname.objectext ),
( subtenantId - Only to be used by tenants, to address a subtenant’s object. If not provided by a tenant, its own object is addressed. Subtenants are not allowed to use this parameter and can only address their own object. )
Returns:None
get_all_delete_objects_job(request_object)[source]

Fetch details of all the Delete Objects Jobs.

Retrieve list of all the Delete Objects Jobs.

Parameters:request_object (GetAllDeleteObjectsJobRequest) – It contains the below parameters –>
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page ),
( filter - JSON-based filter expression. Supported values: ‘subtenantId’ and ‘status’. Supported operations: ‘eq’. Decoded example for exact match: { “subtenantId”: “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4”, “status”: “IN_PROGRESS” } )
Returns:DeleteObjectsJobList
get_delete_objects_job(request_object)[source]

Fetch status and details of Delete Objects Job.

Retrieve information of given Delete Objects Job. <br/> Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant’s objects, the subtenantId query parameter must be used.

Parameters:request_object (GetDeleteObjectsJobRequest) – It contains the below parameters –>
( id* - Unique identifier of the Delete Objects Job ),
( subtenantId - * Only to be used by tenants, to address delete objects jobs on subtenant’s paths. * If not provided by a tenant, then delete objects jobs created for tenant’s will be returned. * Subtenants are not allowed to use this parameter and they can only get delete objects jobs created for them. * e.g. subtenantId “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4”. )
Returns:DeleteObjectsJobResponse
get_delete_objects_job_errors(request_object)[source]

Fetch errors of Delete Objects Job.

Retrieve errors of given Delete Objects Job. This endpoint should be called only when /deleteObjectsJobs/{id} returns status as COMPLETED_WITH_ERRORS<br/> Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant’s objects, the subtenantId query parameter must be used.

Parameters:request_object (GetDeleteObjectsJobErrorsRequest) – It contains the below parameters –>
( id* - Unique identifier of the Delete Objects Job ),
( subtenantId - * Only to be used by tenants, to address delete objects jobs on subtenant’s paths. * If not provided by a tenant, then delete objects jobs created for tenant’s will be returned. * Subtenants are not allowed to use this parameter and they can only get delete objects jobs created for them. * e.g. subtenantId “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4”. )
Returns:DeleteObjectsJobErrorDetailsResponse
query_objects(request_object)[source]

Query objects.

Retrieve information on existing objects. In case a folder is specified as input path, all child objects within the folder are returned. Objects in sub-folders of the given folder are not returned. In case a file is specified as input path, only the file is returned. Only the objects of one tenant or subtenant are returned. In case a tenant wants to retrieve information on a subtenant’s objects, the subtenantId query parameter must be used.

Parameters:request_object (QueryObjectsRequest) – It contains the below parameters –>
( path - Path to folder or file object. In case of folder, all child objects are returned. In case of file, only the corresponding object is returned. ),
( subtenantId - Only to be used by tenants, to address a subtenant’s object. If not provided by a tenant, its own object is addressed. Subtenants are not allowed to use this parameter and can only address their own object. ),
( pageToken - Selects next page. Value must be taken rom response body property ‘page.nextToken’. If omitted, first page is returned. )
Returns:ObjectListResponse

integrateddatalake.clients.object_operations_with_access_token_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class ObjectOperationsWithAccessTokenClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

access_token_permissions(request_object)[source]

Allows to give write premission on folder/path

Allows users (tenant) to give write permission on folder/path. This API can only be accessed by tenant admin. Tenant admin can also provide write permission on subtenant folder. Write permission on root folder can also be given, except TSI folder

Parameters:request_object (AccessTokenPermissionsRequest) – It contains the below parameters –>
( writePathPayload - Optional subtenantId (if path for write permission belongs to the tenant) )
Returns:AccessTokenPermissionResource
delete_access_token_permissions(request_object)[source]

Delete write permission on folder for the given id

Delete write permission on folder for the given id This API can be accessed by tenant admin only

Parameters:request_object (DeleteAccessTokenPermissionsRequest) – It contains the below parameters –>
( id* - Unique identifier of the write enabled folders )
Returns:None
generate_access_token(request_object)[source]

Generate AWS STS token

Allows users to request temporary, limited-privilege AWS credentials to get read-only or write-only access on the URI returned in the response. * Read permission will always be on the root level. * Path field is optional for READ permission - If value for path is not provided then it will be considered on root level (“/”). * Ensure to enable write access on the path before requesting token with write permission. * Write access can be enabled using POST /accessTokenPermissions endpoint. * An access token requested for a given path also automatically gives access to all subpaths of the path. For example, if an access token is requested for path /a and there are subpaths /a/b and /a/b/c, the token allows to access those too. * An access token with write permissions can only be requested for the paths defined by resource accessTokenPermissions. An acecss token with read permissions can only be requested for the root path /.

Parameters:request_object (GenerateAccessTokenRequest) – It contains the below parameters –>
( stsPayload - Optional subtenant ID (if tenant is performing action on behalf of subtenant) )
Returns:AccessTokens
get_access_token_permissions(request_object)[source]

Details of the write folder request for the given id

Details of the write folder request for the given id This API can be accessed by tenant admin, to get details of the request including for subtenants. Subtenant can access this API, to get details of the request belongs to their write folder.

Parameters:request_object (GetAccessTokenPermissionsRequest) – It contains the below parameters –>
( id* - Unique identifier of the write enabled folders )
Returns:AccessTokenPermissionResource
list_access_token_permissions(request_object)[source]

List all folders having write premission

List all folders having write permission. This API can be accessed by tenant admin, to list all write permission folders including of subtenants. Subtenant can access this API, to get list write permission folders owned by subtenant. <h3>Limitations</h3> * <h4>Size parameter value should not be more than 1000.</h4>

Parameters:request_object (ListAccessTokenPermissionsRequest) – It contains the below parameters –>
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page )
Returns:AccessTokenPermissionResources

integrateddatalake.clients.objects_metadata_catalog_operations_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class ObjectsMetadataCatalogOperationsClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

create_or_update_object_metadata(request_object)[source]

Create/Update Metadata for the object.

Create/Update metadata. If tenant is operating for a subtenant object, he should specify subtenant in request query parameter. If path contains special characters which require URL encoding, it should be done as appropriate. Maximum 8 tags are allowed, where each tag can be maximum 128 characters.

Parameters:request_object (CreateOrUpdateObjectMetadataRequest) – It contains the below parameters –>
( path* - path of an object denoting folders and object name. e.g. basefolder/subfolder/objectname.objectext ),
( metadata* - Metadata ),
( subtenantId - Only to be used by tenants, to address a subtenant’s object metadata. If not provided by a tenant, its own object metadata is addressed. Subtenants are not allowed to use this parameter and can only address their own object metadata. e.g. subtenantId “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4” )
Returns:None
query_object_metadata(request_object)[source]

Get a list of metadata

Get Metadata for the object.

Parameters:request_object (QueryObjectMetadataRequest) – It contains the below parameters –>
( filter* - Specifies the additional filtering criteria. This is encoded and is in the JSON format. ‘filter’ should have only one operator from the list [or,and,none]. ‘none’ operator must have only one property from this list [name,size,tags,lastModified,location]. ‘and/or’ operator must have minimum two properties from this list [name,size,tags,lastModified,location]. ),
( subtenantId - Specifies the search based on subtenantId. if, subtenantId is denoted as “**”, it will search for data in tenants & all subtenants. ),
( size - Specifies the number of elements in a page ),
( page - Specifies the requested page index )
Returns:SearchResponse
retrieve_object_metadata(request_object)[source]

Get Metadata for the object.

Get Metadata for the object. If tenant is operating for a subtenant object, he should specify subtenant in request query parameter. If path contains special characters which require URL encoding, it should be done as appropriate.

Parameters:request_object (RetrieveObjectMetadataRequest) – It contains the below parameters –>
( path* - path of an object denoting folders and object name. e.g. basefolder/subfolder/objectname.objectext ),
( subtenantId - * Only to be used by tenants, to address object metadata tags on subtenant’s path. * If not provided by a tenant, then object metadata tags will be taken on tenant’s own path. * Subtenants are not allowed to use this parameter and they can only address object metadata tags on their own path. * e.g. subtenantId “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4”. )
Returns:ObjectMetaDataResponse

integrateddatalake.clients.time_series_bulk_import_client module

Data Lake API

Service for storing Objects, download objects, add extended metadata tags, subscribe for notifications, import tenant specific MindSphere Time Series data, and enable data access using cross account access and STS in Integrated MindSphere Data Lake. - Objects reside in user specified path like below example. Extension in object name is optional. Root path can be denoted as “/” /basefolder/subfolder/objectname.objectext - The following generic error codes might occur at any of the specified operations. Generic errors are prefixed with ‘mdsp.core.generic.’. - missingParameter - invalidParameter - missingRequestBodyProperty - invalidRequestBodyProperty - unauthorized - forbidden - noMatch - unsupportedMediaType - tooManyRequests - internalServerError # noqa: E501

class TimeSeriesBulkImportClient(rest_client_config=None, mindsphere_credentials=None)[source]

Bases: object

create_time_series_import_job(request_object)[source]

Creates a bulk import job of time series data into data lake.

Creates an asynchronous job to bulk import time series data into data lake. The import takes into account time series data from the provided aspects associated to the provided assets, in the given time range.

Parameters:request_object (CreateTimeSeriesImportJobRequest) – It contains the below parameters –>
( ImportJob* - Bulk import job )
Returns:ImportJobResponse
delete_time_series_import_job(request_object)[source]

Delete time series bulk import job by id.

Delete completed time series bulk import job.

Parameters:request_object (DeleteTimeSeriesImportJobRequest) – It contains the below parameters –>
( id* - Unique id of the time series bulk import job. )
Returns:None
query_time_series_import_jobs(request_object)[source]

Query all time series bulk import jobs.

Query all time series bulk import jobs currently existing, which are owned by the client’s tenant or subtenant. If requester is tenant, all the import jobs for the tenant as well as its all subtenants are returned. If requester is a subtenant, all the iport jobs for the subtenant are returned. If tenant wants to filter results for a particular subtenant, filter query parameter subtenantId can be used. This filter query parameter is applicable only if the requester is tenant.

Parameters:request_object (QueryTimeSeriesImportJobsRequest) – It contains the below parameters –>
( page - Specifies the requested page index ),
( size - Specifies the number of elements in a page ),
( filter - JSON-based filter expression. Supported values: ‘subtenantId’. Supported operations: ‘eq’. Decoded example value: { “subtenantId”: “204a896c-a23a-11e9-a2a3-2a2ae2dbcce4” } )
Returns:ImportJobListResource
retrieve_time_series_import_job(request_object)[source]

Retrieve status of time series bulk import job.

Retrieve status of time series bulk import job.

Parameters:request_object (RetrieveTimeSeriesImportJobRequest) – It contains the below parameters –>
( id* - Unique id for getting status of the time series bulk import job. )
Returns:ImportJobResponse
retrieve_time_series_import_job_details(request_object)[source]

Retreive details of a time series bulk import job.

Retreive details of a time series bulk import job. Details are only available once a job is not any longer in status PENDING.

Parameters:request_object (RetrieveTimeSeriesImportJobDetailsRequest) – It contains the below parameters –>
( id* - Unique id for getting status of the time series bulk import job. )
Returns:ImportJobDetails

Module contents