Skip to main content
Control file and table import jobs, integration keys and BYOB connectors. For task-oriented walkthroughs of these operations, see the Data import guide. Every mutation below is sent as a POST to https://app.arize.com/graphql with an x-api-key header; see Forming calls.

Mutations in this page

Reference

createFileImportJob

Create a job that will import model inferences from a blob store createFileImportJob(input: CreateFileImportJobInput!): CreateFileImportJobPayload

Arguments

CreateFileImportJobInput!
required

Returns

Space
JobValidationResult
FilePreviewResult
FileImportJob

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateFileImportJob

Update an existing job that has been imported from a blob store updateFileImportJob(input: UpdateFileImportJobInput!): UpdateFileImportJobPayload

Arguments

UpdateFileImportJobInput!
required

Returns

FileImportJob!
The updated import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

startFileImportJob

Start an existing job that has been imported from a blob store startFileImportJob(input: StartFileImportJobInput!): StartFileImportJobPayload

Arguments

StartFileImportJobInput!
required

Returns

FileImportJob!
The import job which has been started
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

pauseFileImportJob

Pause an existing job that has been imported from a blob store pauseFileImportJob(input: PauseFileImportJobInput!): PauseFileImportJobPayload

Arguments

PauseFileImportJobInput!
required

Returns

FileImportJob!
The paused import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteFileImportJob

Delete an existing job that has been imported from a blob store deleteFileImportJob(input: DeleteFileImportJobInput!): DeleteFileImportJobPayload

Arguments

DeleteFileImportJobInput!
required

Returns

FileImportJob!
The deleted import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

resetFileStatus

Reset the status of a file resetFileStatus(input: ResetFileStatusInput!): ResetFileStatusPayload

Arguments

ResetFileStatusInput!
required

Returns

FileImportJob!
The updated import job

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createTableImportJob

Create a job that will import model inferences from a table createTableImportJob(input: CreateTableImportJobInput!): CreateTableImportJobPayload

Arguments

CreateTableImportJobInput!
required

Returns

Space
TableJobValidationResult
TableImportJob

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateTableImportJob

Update an existing job that has been imported from a table updateTableImportJob(input: UpdateTableImportJobInput!): UpdateTableImportJobPayload

Arguments

UpdateTableImportJobInput!
required

Returns

TableImportJob!
The updated table import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateTableIngestionParameters

Update an existing job that has been imported from a table updateTableIngestionParameters(input: UpdateTableIngestionParametersInput!): UpdateTableIngestionParametersPayload

Arguments

UpdateTableIngestionParametersInput!
required

Returns

TableImportJob!
The updated table import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

startTableImportJob

Start an existing job that has been imported from a table startTableImportJob(input: StartTableImportJobInput!): StartTableImportJobPayload

Arguments

StartTableImportJobInput!
required

Returns

FileImportJob!
The import job which has been started
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

pauseTableImportJob

Pause an existing job that has been imported from a table pauseTableImportJob(input: PauseTableImportJobInput!): PauseTableImportJobPayload

Arguments

PauseTableImportJobInput!
required

Returns

TableImportJob!
The paused import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteTableImportJob

Delete an existing job that has been imported from a table deleteTableImportJob(input: DeleteTableImportJobInput!): DeleteTableImportJobPayload

Arguments

DeleteTableImportJobInput!
required

Returns

TableImportJob!
The deleted table import job
Space!

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createTriggeredOngoingTableImportJob

Create a job that will import model inferences from a table createTriggeredOngoingTableImportJob(input: CreateTriggeredOngoingTableImportJobInput!): CreateTriggeredOngoingTableImportJobPayload

Arguments

CreateTriggeredOngoingTableImportJobInput!
required

Returns

Space
TableJobValidationResult
TableImportJob

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createTriggeredOngoingTableRun

Schedule a job run that will import model inferences from a table createTriggeredOngoingTableRun(input: CreateTriggeredOngoingTableRunInput!): CreateTriggeredOngoingTableRunPayload

Arguments

CreateTriggeredOngoingTableRunInput!
required

Returns

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createIntegrationKey

createIntegrationKey(input: CreateIntegrationKeyInput!): CreateIntegrationKeyPayload

Arguments

CreateIntegrationKeyInput!
required

Returns

IntegrationKey!
The created integration key.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

patchIntegrationKey

patchIntegrationKey(input: PatchIntegrationKeyInput!): PatchIntegrationKeyPayload

Arguments

PatchIntegrationKeyInput!
required

Returns

IntegrationKey!
The updated integration.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

testIntegrationKey

testIntegrationKey(input: TestIntegrationKeyInput!): TestIntegrationKeyPayload

Arguments

TestIntegrationKeyInput!
required

Returns

Int!
The http status code of the test integration endpoint response e.g. 201, 401, etc

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteIntegrationKey

deleteIntegrationKey(input: DeleteIntegrationKeyInput!): DeleteIntegrationKeyPayload

Arguments

DeleteIntegrationKeyInput!
required

Returns

IntegrationKey!
The soft deleted integration key.

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

validateByobConnector

Validate a byob connector validateByobConnector(input: ValidateByobConnectorInput!): ValidateByobConnectorPayload

Arguments

ValidateByobConnectorInput!
required

Returns

Boolean!
Whether the byob connector is valid
ValidationReason
The reason why the byob connector is valid One of: UNKNOWN_INVALID_REASON, FAILED_BUCKET_OWNERSHIP_CHECK, FAILED_BUCKET_ACCESS.
String
The message that explains why the byob connector is valid

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

createByobConnector

Create a byob connector createByobConnector(input: CreateByobConnectorInput!): CreateByobConnectorPayload

Arguments

CreateByobConnectorInput!
required

Returns

ID!
The id of the created byob connector

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateByobConnector

Update a byob connector updateByobConnector(input: UpdateByobConnectorInput!): UpdateByobConnectorPayload

Arguments

UpdateByobConnectorInput!
required

Returns

Boolean
Whether the update was successful

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteByobConnector

Delete a byob connector deleteByobConnector(input: DeleteByobConnectorInput!): DeleteByobConnectorPayload

Arguments

DeleteByobConnectorInput!
required

Returns

Boolean
Whether the delete was successful

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

updateByobSyncedDatasource

Update a byob synced datasource updateByobSyncedDatasource(input: UpdateByobSyncedDatasourceInput!): UpdateByobSyncedDatasourcePayload

Arguments

UpdateByobSyncedDatasourceInput!
required

Returns

Boolean
Whether the update was successful

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.

deleteByobDatasource

Delete a byob datasource deleteByobDatasource(input: DeleteByobDatasourceInput!): DeleteByobDatasourcePayload

Arguments

DeleteByobDatasourceInput!
required

Returns

Boolean
Whether the delete was successful

Example

Only required input fields are shown. Replace <ID> and <string> placeholders with real values; the object graph page shows how to look IDs up.