Method
describeRefreshPipelineRun GET
Copy GET

Retrieve a single refresh pipeline run

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes refreshPipelineRunId str Unique string identifier associated with the refresh pipeline run.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result RefreshPipelineRun
KEY TYPE Description
refreshPipelineRunId str The unique identifier for the refresh pipeline run.
refreshPolicyId str Populated when the run was triggered by a refresh policy.
createdAt str The time when this refresh pipeline run was created, in ISO-8601 format.
startedAt str The time when the refresh pipeline run was started, in ISO-8601 format.
completedAt str The time when the refresh pipeline run was completed, in ISO-8601 format.
status str The status of the refresh pipeline run.
refreshType str The type of refresh policy to be run.
datasetVersions List[str] A list of dataset version IDs that this refresh pipeline run is monitoring.
featureGroupVersion str The feature group version ID that this refresh pipeline run is monitoring.
modelVersions List[str] A list of model version IDs that this refresh pipeline run is monitoring.
deploymentVersions List[str] A list of deployment version IDs that this refresh pipeline run is monitoring.
batchPredictions List[str] A list of batch prediction IDs that this refresh pipeline run is monitoring.
refreshPolicy RefreshPolicy The refresh policy for this refresh policy run.
KEY TYPE Description
refreshPolicyId str The unique identifier for the refresh policy
name str The user-friendly name for the refresh policy
cron str A cron-style string that describes when this refresh policy is to be executed in UTC
nextRunTime str The next UTC time that this refresh policy will be executed
createdAt str The time when the refresh policy was created
refreshType str The type of refresh policy to be run
projectId str The unique identifier of a project that this refresh policy applies to
datasetIds List[str] Comma-separated list of Dataset IDs that this refresh policy applies to
featureGroupId str Feature Group ID that this refresh policy applies to
modelIds List[str] Comma-separated list of Model IDs that this refresh policy applies to
deploymentIds List[str] Comma-separated list of Deployment IDs that this refresh policy applies to
batchPredictionIds List[str] Comma-separated list of Batch Prediction IDs that this refresh policy applies to
modelMonitorIds List[str] Comma-separated list of Model Monitor IDs that this refresh policy applies to
notebookId str Notebook ID that this refresh policy applies to
paused bool True if the refresh policy is paused
predictionOperatorId str Prediction Operator ID that this refresh policy applies to
pipelineId str The Pipeline ID With The Cron Schedule
featureGroupExportConfig FeatureGroupRefreshExportConfig The export configuration for the feature group. Only applicable if refresh_type is FEATUREGROUP.
KEY TYPE Description
connectorType str The type of connector the feature group is
location str The file connector location of the feature group export
exportFileFormat str The file format of the feature group export
additionalIdColumns list Additional id columns to use for upsert operations
databaseFeatureMapping dict The mapping of feature names to database columns
externalConnectionId str The unique identifier of the external connection to write to
idColumn str The column to use as the id column for upsert operations
objectName str The name of the object to write to
writeMode str The write mode to use for the export

Exceptions:

TYPE WHEN
DataNotFoundError

refreshPipelineRunId is not found.
Language:

© Copyright