Skip to main content
Send feedback
Gemini Enterprise Agent Platform IAM permissions
Stay organized with collections
Save and categorize content based on your preferences.
The following table lists common Agent Platform operations and the
permissions that they require.
To determine if one or more permissions are included in a
Gemini Enterprise Agent Platform IAM role ,
you can use one of the following methods:
Resource
Operation
Permissions needed
batchPredictionJobs
Cancel a batchPredictionJob
aiplatform.batchPredictionJobs.cancel
(permission needed on the name
resource)
batchPredictionJobs
Create a batchPredictionJob
aiplatform.batchPredictionJobs.create
(permission needed on the parent
resource)
batchPredictionJobs
Delete a batchPredictionJob
† † Starts a long-running operation
aiplatform.batchPredictionJobs.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.batchPredictionJobs.get (to call GET on the long-running operation returned)
aiplatform.batchPredictionJobs.get (to call DELETE on the long-running operation returned)
aiplatform.batchPredictionJobs.get (to call WAIT on the long-running operation returned)
aiplatform.batchPredictionJobs.delete (to call CANCEL on the long-running operation returned)
batchPredictionJobs
Get a batchPredictionJob
aiplatform.batchPredictionJobs.get
(permission needed on the name
resource)
batchPredictionJobs
List a batchPredictionJob
aiplatform.batchPredictionJobs.list
(permission needed on the parent
resource)
customJobs
Cancel a customJob
aiplatform.customJobs.cancel
(permission needed on the name
resource)
customJobs
Create a customJob
aiplatform.customJobs.create
(permission needed on the parent
resource)
customJobs
Delete a customJob
† † Starts a long-running operation
aiplatform.customJobs.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.customJobs.get (to call GET on the long-running operation returned)
aiplatform.customJobs.get (to call DELETE on the long-running operation returned)
aiplatform.customJobs.get (to call WAIT on the long-running operation returned)
aiplatform.customJobs.delete (to call CANCEL on the long-running operation returned)
customJobs
Get a customJob
aiplatform.customJobs.get
(permission needed on the name
resource)
customJobs
List a customJob
aiplatform.customJobs.list
(permission needed on the parent
resource)
datasets
Create a dataset
† † Starts a long-running operation
aiplatform.datasets.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
datasets
Delete a dataset
† † Starts a long-running operation
aiplatform.datasets.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.delete (to call CANCEL on the long-running operation returned)
datasets
Export a dataset
† † Starts a long-running operation
aiplatform.datasets.export
(permission needed on the name
resource)
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.export (to call CANCEL on the long-running operation returned)
datasets
Get a dataset
aiplatform.datasets.get
(permission needed on the name
resource)
datasets
Import a dataset
† † Starts a long-running operation
aiplatform.datasets.import
(permission needed on the name
resource)
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.import (to call CANCEL on the long-running operation returned)
datasets
List a dataset
aiplatform.datasets.list
(permission needed on the parent
resource)
datasets
Update a dataset
aiplatform.datasets.update
(permission needed on the name
resource)
datasets.annotationSpecs
Get a dataset's annotationSpecs
aiplatform.annotationSpecs.get
(permission needed on the name
resource)
datasets.dataItems
List a dataset's dataItems
aiplatform.dataItems.list
(permission needed on the parent
resource)
datasets.dataItems.annotations
List a dataset.dataItems.annotations
aiplatform.annotations.list
(permission needed on the parent
resource)
datasets.savedQueries
Lists SavedQueries in a Dataset.
aiplatform.datasets.get
(permission needed on the parent
resource)
endpoints
Create an endpoint
† † Starts a long-running operation
aiplatform.endpoints.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.endpoints.get (to call GET on the long-running operation returned)
aiplatform.endpoints.update (to call DELETE on the long-running operation returned)
aiplatform.endpoints.get (to call WAIT on the long-running operation returned)
aiplatform.endpoints.update (to call CANCEL on the long-running operation returned)
endpoints
Delete an endpoint
† † Starts a long-running operation
aiplatform.endpoints.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.endpoints.get (to call GET on the long-running operation returned)
aiplatform.endpoints.update (to call DELETE on the long-running operation returned)
aiplatform.endpoints.get (to call WAIT on the long-running operation returned)
aiplatform.endpoints.delete (to call CANCEL on the long-running operation returned)
endpoints
Deploy model to an endpoint
† † Starts a long-running operation
aiplatform.endpoints.deploy
(permission needed on the endpoint
resource)
Other permissions:
aiplatform.endpoints.get (to call GET on the long-running operation returned)
aiplatform.endpoints.update (to call DELETE on the long-running operation returned)
aiplatform.endpoints.get (to call WAIT on the long-running operation returned)
aiplatform.endpoints.deploy (to call CANCEL on the long-running operation returned)
endpoints
Explain an endpoint
aiplatform.endpoints.explain
(permission needed on the endpoint
resource)
endpoints
Get an endpoint
aiplatform.endpoints.get
(permission needed on the name
resource)
endpoints
List an endpoint
aiplatform.endpoints.list
(permission needed on the parent
resource)
endpoints
Update an endpoint
aiplatform.endpoints.update
(permission needed on the name
resource)
endpoints
Predict an endpoint
aiplatform.endpoints.predict
(permission needed on the endpoint
resource)
endpoints
Perform an online prediction with an arbitrary HTTP payload.
aiplatform.endpoints.predict
(permission needed on the endpoint
resource)
endpoints
Undeploy a model to an endpoint
† † Starts a long-running operation
aiplatform.endpoints.undeploy
(permission needed on the endpoint
resource)
Other permissions:
aiplatform.endpoints.get (to call GET on the long-running operation returned)
aiplatform.endpoints.update (to call DELETE on the long-running operation returned)
aiplatform.endpoints.get (to call WAIT on the long-running operation returned)
aiplatform.endpoints.undeploy (to call CANCEL on the long-running operation returned)
featurestores
Batch reads Feature values from a Featurestore.
† † Starts a long-running operation
aiplatform.featurestores.batchReadFeatureValues
(permission needed on the featurestore
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.batchReadFeatureValues (to call CANCEL on the long-running operation returned)
featurestores
Creates a new Featurestore in a given project and location.
† † Starts a long-running operation
aiplatform.featurestores.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores
Deletes a single Featurestore.
† † Starts a long-running operation
aiplatform.featurestores.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
featurestores
Gets details of a single Featurestore.
aiplatform.featurestores.get
(permission needed on the name
resource)
featurestores
Lists Featurestores in a given project and location.
aiplatform.featurestores.list
(permission needed on the parent
resource)
featurestores
Updates the parameters of a single Featurestore.
† † Starts a long-running operation
aiplatform.featurestores.update
(permission needed on the name
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
featurestores
Searches Features matching a query in a given project.
aiplatform.features.list
(permission needed on the location
resource)
featurestores.entityTypes
Creates a new EntityType in a given Featurestore.
† † Starts a long-running operation
aiplatform.entityTypes.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores.entityTypes
Deletes a single EntityType.
† † Starts a long-running operation
aiplatform.entityTypes.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores.entityTypes
Exports Feature values from all the entities of a target EntityType.
† † Starts a long-running operation
aiplatform.entityTypes.exportFeatureValues
(permission needed on the entityType
resource)
Other permissions:
aiplatform.entityTypes.get (to call GET on the long-running operation returned)
aiplatform.entityTypes.update (to call DELETE on the long-running operation returned)
aiplatform.entityTypes.get (to call WAIT on the long-running operation returned)
aiplatform.entityTypes.exportFeatureValues (to call CANCEL on the long-running operation returned)
featurestores.entityTypes
Gets details of a single EntityType.
aiplatform.entityTypes.get
(permission needed on the name
resource)
featurestores.entityTypes
Imports Feature values into the Featurestore from a source storage.
† † Starts a long-running operation
aiplatform.entityTypes.importFeatureValues
(permission needed on the entityType
resource)
Other permissions:
aiplatform.entityTypes.get (to call GET on the long-running operation returned)
aiplatform.entityTypes.update (to call DELETE on the long-running operation returned)
aiplatform.entityTypes.get (to call WAIT on the long-running operation returned)
aiplatform.entityTypes.importFeatureValues (to call CANCEL on the long-running operation returned)
featurestores.entityTypes
Lists EntityTypes in a given Featurestore.
aiplatform.entityTypes.list
(permission needed on the parent
resource)
featurestores.entityTypes
Updates the parameters of a single EntityType.
aiplatform.entityTypes.update
(permission needed on the name
resource)
featurestores.entityTypes
Reads Feature values of a specific entity of an EntityType.
aiplatform.entityTypes.readFeatureValues
(permission needed on the entityType
resource)
featurestores.entityTypes
Reads Feature values for multiple entities.
aiplatform.entityTypes.streamingReadFeatureValues
(permission needed on the entityType
resource)
featurestores.entityTypes.features
Creates a batch of Features in a given EntityType.
† † Starts a long-running operation
aiplatform.features.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores.entityTypes.features
Creates a new Feature in a given EntityType.
† † Starts a long-running operation
aiplatform.features.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores.entityTypes.features
Deletes a single Feature.
† † Starts a long-running operation
aiplatform.features.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.update (to call CANCEL on the long-running operation returned)
featurestores.entityTypes.features
Gets details of a single Feature.
aiplatform.features.get
(permission needed on the name
resource)
featurestores.entityTypes.features
Lists Features in a given EntityType.
aiplatform.features.list
(permission needed on the parent
resource)
featurestores.entityTypes.features
Updates the paramters of a single Feature
aiplatform.features.update
(permission needed on the name
resource)
hyperparameterTuningJobs
Cancel a hyperparameterTuningJob
aiplatform.hyperparameterTuningJobs.cancel
(permission needed on the name
resource)
hyperparameterTuningJobs
Create a hyperparameterTuningJob
aiplatform.hyperparameterTuningJobs.create
(permission needed on the parent
resource)
hyperparameterTuningJobs
Delete a hyperparameterTuningJob
aiplatform.hyperparameterTuningJobs.delete
(permission needed on the name
resource)
hyperparameterTuningJobs
Get a hyperparameterTuningJob
aiplatform.hyperparameterTuningJobs.get
(permission needed on the name
resource)
hyperparameterTuningJobs
List a hyperparameterTuningJob
aiplatform.hyperparameterTuningJobs.list
(permission needed on the parent
resource)
indexEndpoints
Creates an IndexEndpoint.
† † Starts a long-running operation
aiplatform.indexEndpoints.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.indexEndpoints.get (to call GET on the long-running operation returned)
aiplatform.indexEndpoints.update (to call DELETE on the long-running operation returned)
aiplatform.indexEndpoints.get (to call WAIT on the long-running operation returned)
aiplatform.indexEndpoints.update (to call CANCEL on the long-running operation returned)
indexEndpoints
Deletes an IndexEndpoint.
† † Starts a long-running operation
aiplatform.indexEndpoints.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.indexEndpoints.get (to call GET on the long-running operation returned)
aiplatform.indexEndpoints.update (to call DELETE on the long-running operation returned)
aiplatform.indexEndpoints.get (to call WAIT on the long-running operation returned)
aiplatform.indexEndpoints.update (to call CANCEL on the long-running operation returned)
indexEndpoints
Deploys an Index into this IndexEndpoint, creating a DeployedIndex within it.
† † Starts a long-running operation
aiplatform.indexEndpoints.deploy
(permission needed on the indexEndpoint
resource)
Other permissions:
aiplatform.indexEndpoints.get (to call GET on the long-running operation returned)
aiplatform.indexEndpoints.update (to call DELETE on the long-running operation returned)
aiplatform.indexEndpoints.get (to call WAIT on the long-running operation returned)
aiplatform.indexEndpoints.update (to call CANCEL on the long-running operation returned)
indexEndpoints
Gets an IndexEndpoint.
aiplatform.indexEndpoints.get
(permission needed on the name
resource)
indexEndpoints
Lists IndexEndpoints in a Location.
aiplatform.indexEndpoints.list
(permission needed on the parent
resource)
indexEndpoints
Update an existing DeployedIndex under an IndexEndpoint.
† † Starts a long-running operation
aiplatform.indexEndpoints.deploy
(permission needed on the indexEndpoint
resource)
Other permissions:
aiplatform.indexEndpoints.get (to call GET on the long-running operation returned)
aiplatform.indexEndpoints.update (to call DELETE on the long-running operation returned)
aiplatform.indexEndpoints.get (to call WAIT on the long-running operation returned)
aiplatform.indexEndpoints.update (to call CANCEL on the long-running operation returned)
indexEndpoints
Updates an IndexEndpoint.
aiplatform.indexEndpoints.update
(permission needed on the name
resource)
indexEndpoints
Undeploys an Index from an IndexEndpoint, removing a DeployedIndex from it, and freeing all resources it's using.
† † Starts a long-running operation
aiplatform.indexEndpoints.undeploy
(permission needed on the indexEndpoint
resource)
Other permissions:
aiplatform.indexEndpoints.get (to call GET on the long-running operation returned)
aiplatform.indexEndpoints.update (to call DELETE on the long-running operation returned)
aiplatform.indexEndpoints.get (to call WAIT on the long-running operation returned)
aiplatform.indexEndpoints.update (to call CANCEL on the long-running operation returned)
indexes
Creates an Index.
† † Starts a long-running operation
aiplatform.indexes.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.indexes.get (to call GET on the long-running operation returned)
aiplatform.indexes.update (to call DELETE on the long-running operation returned)
aiplatform.indexes.get (to call WAIT on the long-running operation returned)
aiplatform.indexes.update (to call CANCEL on the long-running operation returned)
indexes
Deletes an Index.
† † Starts a long-running operation
aiplatform.indexes.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.indexes.get (to call GET on the long-running operation returned)
aiplatform.indexes.update (to call DELETE on the long-running operation returned)
aiplatform.indexes.get (to call WAIT on the long-running operation returned)
aiplatform.indexes.update (to call CANCEL on the long-running operation returned)
indexes
Gets an Index.
aiplatform.indexes.get
(permission needed on the name
resource)
indexes
Lists Indexes in a Location.
aiplatform.indexes.list
(permission needed on the parent
resource)
indexes
Updates an Index.
† † Starts a long-running operation
aiplatform.indexes.update
(permission needed on the name
resource)
Other permissions:
aiplatform.indexes.get (to call GET on the long-running operation returned)
aiplatform.indexes.update (to call DELETE on the long-running operation returned)
aiplatform.indexes.get (to call WAIT on the long-running operation returned)
aiplatform.indexes.update (to call CANCEL on the long-running operation returned)
metadataStores
Initializes a MetadataStore, including allocation of resources.
† † Starts a long-running operation
aiplatform.metadataStores.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.locations.get (to call WAIT on the long-running operation returned)
aiplatform.locations.get (to call CANCEL on the long-running operation returned)
metadataStores
Deletes a single MetadataStore and all its child resources (Artifacts, Executions, and Contexts).
† † Starts a long-running operation
aiplatform.metadataStores.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.locations.get (to call WAIT on the long-running operation returned)
aiplatform.locations.get (to call CANCEL on the long-running operation returned)
metadataStores
Retrieves a specific MetadataStore.
aiplatform.metadataStores.get
(permission needed on the name
resource)
metadataStores
Lists MetadataStores for a Location.
aiplatform.metadataStores.list
(permission needed on the parent
resource)
metadataStores.artifacts
Creates an Artifact associated with a MetadataStore.
aiplatform.artifacts.create
(permission needed on the parent
resource)
metadataStores.artifacts
Deletes an Artifact.
† † Starts a long-running operation
aiplatform.artifacts.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.artifacts.get (to call GET on the long-running operation returned)
aiplatform.artifacts.delete (to call DELETE on the long-running operation returned)
aiplatform.artifacts.get (to call WAIT on the long-running operation returned)
aiplatform.artifacts.delete (to call CANCEL on the long-running operation returned)
metadataStores.artifacts
Retrieves a specific Artifact.
aiplatform.artifacts.get
(permission needed on the name
resource)
metadataStores.artifacts
Lists Artifacts in the MetadataStore.
aiplatform.artifacts.list
(permission needed on the parent
resource)
metadataStores.artifacts
Updates a stored Artifact.
aiplatform.artifacts.update
(permission needed on the name
resource)
metadataStores.artifacts
Purges Artifacts.
† † Starts a long-running operation
aiplatform.artifacts.delete
(permission needed on the parent
resource)
Other permissions:
aiplatform.artifacts.get (to call GET on the long-running operation returned)
aiplatform.artifacts.delete (to call DELETE on the long-running operation returned)
aiplatform.artifacts.get (to call WAIT on the long-running operation returned)
aiplatform.artifacts.delete (to call CANCEL on the long-running operation returned)
metadataStores.artifacts
Retrieves lineage of an Artifact represented through Artifacts and Executions connected by Event edges and returned as a LineageSubgraph.
aiplatform.artifacts.get
(permission needed on the artifact
resource)
metadataStores.contexts
Adds a set of Artifacts and Executions to a Context.
aiplatform.contexts.addContextArtifactsAndExecutions
(permission needed on the context
resource)
metadataStores.contexts
Adds a set of Contexts as children to a parent Context.
aiplatform.contexts.addContextChildren
(permission needed on the context
resource)
metadataStores.contexts
Creates a Context associated with a MetadataStore.
aiplatform.contexts.create
(permission needed on the parent
resource)
metadataStores.contexts
Deletes a stored Context.
† † Starts a long-running operation
aiplatform.contexts.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.contexts.get (to call GET on the long-running operation returned)
aiplatform.contexts.delete (to call DELETE on the long-running operation returned)
aiplatform.contexts.get (to call WAIT on the long-running operation returned)
aiplatform.contexts.delete (to call CANCEL on the long-running operation returned)
metadataStores.contexts
Retrieves a specific Context.
aiplatform.contexts.get
(permission needed on the name
resource)
metadataStores.contexts
Lists Contexts on the MetadataStore.
aiplatform.contexts.list
(permission needed on the parent
resource)
metadataStores.contexts
Updates a stored Context.
aiplatform.contexts.update
(permission needed on the name
resource)
metadataStores.contexts
Purges Contexts.
† † Starts a long-running operation
aiplatform.contexts.delete
(permission needed on the parent
resource)
Other permissions:
aiplatform.contexts.get (to call GET on the long-running operation returned)
aiplatform.contexts.delete (to call DELETE on the long-running operation returned)
aiplatform.contexts.get (to call WAIT on the long-running operation returned)
aiplatform.contexts.delete (to call CANCEL on the long-running operation returned)
metadataStores.contexts
Retrieves Artifacts and Executions within the specified Context, connected by Event edges and returned as a LineageSubgraph.
aiplatform.contexts.queryContextLineageSubgraph
(permission needed on the context
resource)
metadataStores.executions
Adds Events to the specified Execution.
aiplatform.executions.addExecutionEvents
(permission needed on the execution
resource)
metadataStores.executions
Creates an Execution associated with a MetadataStore.
aiplatform.executions.create
(permission needed on the parent
resource)
metadataStores.executions
Deletes an Execution.
† † Starts a long-running operation
aiplatform.executions.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.executions.get (to call GET on the long-running operation returned)
aiplatform.executions.delete (to call DELETE on the long-running operation returned)
aiplatform.executions.get (to call WAIT on the long-running operation returned)
aiplatform.executions.delete (to call CANCEL on the long-running operation returned)
metadataStores.executions
Retrieves a specific Execution.
aiplatform.executions.get
(permission needed on the name
resource)
metadataStores.executions
Lists Executions in the MetadataStore.
aiplatform.executions.list
(permission needed on the parent
resource)
metadataStores.executions
Updates a stored Execution.
aiplatform.executions.update
(permission needed on the name
resource)
metadataStores.executions
Purges Executions.
† † Starts a long-running operation
aiplatform.executions.delete
(permission needed on the parent
resource)
Other permissions:
aiplatform.executions.get (to call GET on the long-running operation returned)
aiplatform.executions.delete (to call DELETE on the long-running operation returned)
aiplatform.executions.get (to call WAIT on the long-running operation returned)
aiplatform.executions.delete (to call CANCEL on the long-running operation returned)
metadataStores.executions
Obtains the set of input and output Artifacts for this Execution, in the form of LineageSubgraph that also contains the Execution and connecting Events.
aiplatform.executions.queryExecutionInputsAndOutputs
(permission needed on the execution
resource)
metadataStores.metadataSchemas
Creates a MetadataSchema.
aiplatform.metadataSchemas.create
(permission needed on the parent
resource)
metadataStores.metadataSchemas
Retrieves a specific MetadataSchema.
aiplatform.metadataSchemas.get
(permission needed on the name
resource)
metadataStores.metadataSchemas
Lists MetadataSchemas.
aiplatform.metadataSchemas.list
(permission needed on the parent
resource)
migratableResources
Batchmigrate a migratableResource
aiplatform.migratableResources.migrate
(permission needed on the parent
resource)
migratableResources
Search a migratableResource
aiplatform.migratableResources.search
(permission needed on the parent
resource)
modelDeploymentMonitoringJobs
Creates a ModelDeploymentMonitoringJob.
aiplatform.modelDeploymentMonitoringJobs.create
(permission needed on the parent
resource)
modelDeploymentMonitoringJobs
Deletes a ModelDeploymentMonitoringJob.
† † Starts a long-running operation
aiplatform.modelDeploymentMonitoringJobs.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.indexes.get (to call GET on the long-running operation returned)
aiplatform.indexes.update (to call DELETE on the long-running operation returned)
aiplatform.indexes.get (to call WAIT on the long-running operation returned)
aiplatform.indexes.update (to call CANCEL on the long-running operation returned)
modelDeploymentMonitoringJobs
Gets a ModelDeploymentMonitoringJob.
aiplatform.modelDeploymentMonitoringJobs.get
(permission needed on the name
resource)
modelDeploymentMonitoringJobs
Lists ModelDeploymentMonitoringJobs in a Location.
aiplatform.modelDeploymentMonitoringJobs.list
(permission needed on the parent
resource)
modelDeploymentMonitoringJobs
Updates a ModelDeploymentMonitoringJob.
† † Starts a long-running operation
aiplatform.modelDeploymentMonitoringJobs.update
(permission needed on the name
resource)
Other permissions:
aiplatform.modelDeploymentMonitoringJobs.get (to call GET on the long-running operation returned)
aiplatform.modelDeploymentMonitoringJobs.update (to call DELETE on the long-running operation returned)
modelDeploymentMonitoringJobs
Pauses a ModelDeploymentMonitoringJob.
aiplatform.modelDeploymentMonitoringJobs.pause
(permission needed on the name
resource)
modelDeploymentMonitoringJobs
Resumes a paused ModelDeploymentMonitoringJob.
aiplatform.modelDeploymentMonitoringJobs.resume
(permission needed on the name
resource)
modelDeploymentMonitoringJobs
Searches Model Monitoring Statistics generated within a given time window.
aiplatform.modelDeploymentMonitoringJobs.searchStatsAnomalies
(permission needed on the modelDeploymentMonitoringJob
resource)
models
Delete a model
† † Starts a long-running operation
aiplatform.models.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.models.get (to call GET on the long-running operation returned)
aiplatform.models.get (to call DELETE on the long-running operation returned)
aiplatform.models.get (to call WAIT on the long-running operation returned)
aiplatform.models.delete (to call CANCEL on the long-running operation returned)
models
Export a model
† † Starts a long-running operation
aiplatform.models.export
(permission needed on the name
resource)
Other permissions:
aiplatform.models.get (to call GET on the long-running operation returned)
aiplatform.models.get (to call DELETE on the long-running operation returned)
aiplatform.models.get (to call WAIT on the long-running operation returned)
aiplatform.models.export (to call CANCEL on the long-running operation returned)
models
Get a model
aiplatform.models.get
(permission needed on the name
resource)
models
List a model
aiplatform.models.list
(permission needed on the parent
resource)
models
Update a model
aiplatform.models.update
(permission needed on the name
resource)
models
Upload a model
† † Starts a long-running operation
aiplatform.models.upload
(permission needed on the parent
resource)
Other permissions:
aiplatform.models.get (to call GET on the long-running operation returned)
aiplatform.models.get (to call DELETE on the long-running operation returned)
aiplatform.models.get (to call WAIT on the long-running operation returned)
aiplatform.models.update (to call CANCEL on the long-running operation returned)
models.evaluations
Get a model evaluation
aiplatform.modelEvaluations.get
(permission needed on the name
resource)
models.evaluations
List a model evaluation
aiplatform.modelEvaluations.list
(permission needed on the parent
resource)
models.evaluations.slices
Get a model evaluations slice
aiplatform.modelEvaluationSlices.get
(permission needed on the name
resource)
models.evaluations.slices
List a model evaluations slice
aiplatform.modelEvaluationSlices.list
(permission needed on the parent
resource)
pipelineJobs
Cancel a pipelineJob
aiplatform.pipelineJobs.cancel
(permission needed on the name
resource)
pipelineJobs
Create a pipelineJob
aiplatform.pipelineJobs.create
(permission needed on the parent
resource)
pipelineJobs
Delete a pipelineJob
† † Starts a long-running operation
aiplatform.pipelineJobs.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.pipelinejobs.get (to call GET on the long-running operation returned)
aiplatform.pipelinejobs.get (to call DELETE on the long-running operation returned)
pipelineJobs
Get a pipelineJob
aiplatform.pipelineJobs.get
(permission needed on the name
resource)
pipelineJobs
List a pipelineJob
aiplatform.pipelineJobs.list
(permission needed on the parent
resource)
specialistPools
Create a specialistPool
† † Starts a long-running operation
aiplatform.specialistPools.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.specialistPools.get (to call GET on the long-running operation returned)
aiplatform.specialistPools.update (to call DELETE on the long-running operation returned)
aiplatform.specialistPools.get (to call WAIT on the long-running operation returned)
aiplatform.specialistPools.update (to call CANCEL on the long-running operation returned)
specialistPools
Delete a specialistPool
† † Starts a long-running operation
aiplatform.specialistPools.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.specialistPools.get (to call GET on the long-running operation returned)
aiplatform.specialistPools.update (to call DELETE on the long-running operation returned)
aiplatform.specialistPools.get (to call WAIT on the long-running operation returned)
aiplatform.specialistPools.delete (to call CANCEL on the long-running operation returned)
specialistPools
Get a specialistPool
aiplatform.specialistPools.get
(permission needed on the name
resource)
specialistPools
List a specialistPool
aiplatform.specialistPools.list
(permission needed on the parent
resource)
specialistPools
Update a specialistPool
† † Starts a long-running operation
aiplatform.specialistPools.update
(permission needed on the name
resource)
Other permissions:
aiplatform.specialistPools.get (to call GET on the long-running operation returned)
aiplatform.specialistPools.update (to call DELETE on the long-running operation returned)
aiplatform.specialistPools.get (to call WAIT on the long-running operation returned)
aiplatform.specialistPools.update (to call CANCEL on the long-running operation returned)
studies
Creates a Study.
aiplatform.studies.create
(permission needed on the parent
resource)
studies
Deletes a Study.
aiplatform.studies.delete
(permission needed on the name
resource)
studies
Gets a Study by name.
aiplatform.studies.get
(permission needed on the name
resource)
studies
Lists all the studies in a region for an associated project.
aiplatform.studies.list
(permission needed on the parent
resource)
studies
Looks a study up using the user-defined displayName field instead of the fully qualified resource name.
aiplatform.studies.list
(permission needed on the parent
resource)
studies.trials
Adds a measurement of the objective metrics to a Trial.
aiplatform.trials.update
(permission needed on the trialName
resource)
studies.trials
Checks whether a Trial should stop or not.
† † Starts a long-running operation
aiplatform.trials.get
(permission needed on the trialName
resource)
Other permissions:
aiplatform.trials.get (to call GET on the long-running operation returned)
aiplatform.trials.update (to call DELETE on the long-running operation returned)
aiplatform.trials.get (to call WAIT on the long-running operation returned)
aiplatform.trials.update (to call CANCEL on the long-running operation returned)
studies.trials
Marks a Trial as complete.
aiplatform.trials.update
(permission needed on the name
resource)
studies.trials
Adds a user provided Trial to a Study.
aiplatform.trials.create
(permission needed on the parent
resource)
studies.trials
Deletes a Trial.
aiplatform.trials.delete
(permission needed on the name
resource)
studies.trials
Gets a Trial.
aiplatform.trials.get
(permission needed on the name
resource)
studies.trials
Lists the Trials associated with a Study.
aiplatform.trials.list
(permission needed on the parent
resource)
studies.trials
Lists the pareto-optimal Trials for multi-objective Study or the optimal Trials for single-objective Study.
aiplatform.trials.list
(permission needed on the parent
resource)
studies.trials
Stops a Trial.
aiplatform.trials.update
(permission needed on the name
resource)
studies.trials
Adds one or more Trials to a Study, with parameter values suggested by Vertex AI Vizier.
† † Starts a long-running operation
aiplatform.trials.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.studies.get (to call GET on the long-running operation returned)
aiplatform.studies.update (to call DELETE on the long-running operation returned)
aiplatform.studies.get (to call WAIT on the long-running operation returned)
aiplatform.studies.update (to call CANCEL on the long-running operation returned)
tensorboards
Creates a Tensorboard.
† † Starts a long-running operation
aiplatform.tensorboards.create
(permission needed on the parent
resource)
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.locations.get (to call WAIT on the long-running operation returned)
aiplatform.locations.get (to call CANCEL on the long-running operation returned)
tensorboards
Deletes a Tensorboard.
† † Starts a long-running operation
aiplatform.tensorboards.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.tensorboardRuns.get (to call GET on the long-running operation returned)
aiplatform.tensorboardRuns.update (to call DELETE on the long-running operation returned)
aiplatform.tensorboardRuns.get (to call WAIT on the long-running operation returned)
aiplatform.tensorboardRuns.delete (to call CANCEL on the long-running operation returned)
tensorboards
Gets a Tensorboard.
aiplatform.tensorboards.get
(permission needed on the name
resource)
tensorboards
Lists Tensorboards in a Location.
aiplatform.tensorboards.list
(permission needed on the parent
resource)
tensorboards
Updates a Tensorboard.
† † Starts a long-running operation
aiplatform.tensorboards.update
(permission needed on the name
resource)
Other permissions:
aiplatform.tensorboards.get (to call GET on the long-running operation returned)
aiplatform.tensorboards.update (to call DELETE on the long-running operation returned)
aiplatform.tensorboards.get (to call WAIT on the long-running operation returned)
aiplatform.tensorboards.update (to call CANCEL on the long-running operation returned)
tensorboards.experiments
Creates a TensorboardExperiment.
aiplatform.tensorboardExperiments.create
(permission needed on the parent
resource)
tensorboards.experiments
Deletes a TensorboardExperiment.
† † Starts a long-running operation
aiplatform.tensorboardExperiments.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.tensorboardExperiments.get (to call GET on the long-running operation returned)
aiplatform.tensorboardExperiments.update (to call DELETE on the long-running operation returned)
aiplatform.tensorboardExperiments.get (to call WAIT on the long-running operation returned)
aiplatform.tensorboardExperiments.delete (to call CANCEL on the long-running operation returned)
tensorboards.experiments
Gets a TensorboardExperiment.
aiplatform.tensorboardExperiments.get
(permission needed on the name
resource)
tensorboards.experiments
Lists TensorboardExperiments in a Location
aiplatform.tensorboardExperiments.list
(permission needed on the parent
resource)
tensorboards.experiments
Updates a TensorboardExperiment.
aiplatform.tensorboardExperiments.update
(permission needed on the name
resource)
tensorboards.experiments
Write time series data points of multiple TensorboardTimeSeries in multiple TensorboardRun's.
aiplatform.tensorboardExperiments.write
(permission needed on the tensorboardExperiment
resource)
tensorboards.experiments.runs
Batch create TensorboardRuns.
aiplatform.tensorboardRuns.batchCreate
(permission needed on the parent
resource)
tensorboards.experiments.runs
Creates a TensorboardRun.
aiplatform.tensorboardRuns.create
(permission needed on the parent
resource)
tensorboards.experiments.runs
Deletes a TensorboardRun.
† † Starts a long-running operation
aiplatform.tensorboardRuns.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.tensorboardRuns.get (to call GET on the long-running operation returned)
aiplatform.tensorboardRuns.update (to call DELETE on the long-running operation returned)
aiplatform.tensorboardRuns.get (to call WAIT on the long-running operation returned)
aiplatform.tensorboardRuns.delete (to call CANCEL on the long-running operation returned)
tensorboards.experiments.runs
Gets a TensorboardRun.
aiplatform.tensorboardRuns.get
(permission needed on the name
resource)
tensorboards.experiments.runs
Lists TensorboardRuns in a Location.
aiplatform.tensorboardRuns.list
(permission needed on the parent
resource)
tensorboards.experiments.runs
Updates a TensorboardRun.
aiplatform.tensorboardRuns.update
(permission needed on the name
resource)
tensorboards.experiments.runs
Write time series data points into multiple TensorboardTimeSeries under a TensorboardRun.
aiplatform.tensorboardRuns.write
(permission needed on the tensorboardRun
resource)
tensorboards.experiments.runs.timeSeries
Batch create TensorboardTimeSeries that belong to a TensorboardExperiment.
aiplatform.tensorboardTimeSeries.batchCreate
(permission needed on the parent
resource)
tensorboards.experiments.runs.timeSeries
Reads multiple TensorboardTimeSeries' data.
aiplatform.tensorboardTimeSeries.batchRead
(permission needed on the tensorboard
resource)
tensorboards.experiments.runs.timeSeries
Creates a TensorboardTimeSeries.
aiplatform.tensorboardTimeSeries.create
(permission needed on the parent
resource)
tensorboards.experiments.runs.timeSeries
Deletes a TensorboardTimeSeries.
† † Starts a long-running operation
aiplatform.tensorboardTimeSeries.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.tensorboardRuns.get (to call GET on the long-running operation returned)
aiplatform.tensorboardRuns.update (to call DELETE on the long-running operation returned)
tensorboards.experiments.runs.timeSeries
Exports a TensorboardTimeSeries' data.
aiplatform.tensorboardTimeSeries.read
(permission needed on the tensorboardTimeSeries
resource)
tensorboards.experiments.runs.timeSeries
Gets a TensorboardTimeSeries.
aiplatform.tensorboardTimeSeries.get
(permission needed on the name
resource)
tensorboards.experiments.runs.timeSeries
Lists TensorboardTimeSeries in a Location.
aiplatform.tensorboardTimeSeries.list
(permission needed on the parent
resource)
tensorboards.experiments.runs.timeSeries
Updates a TensorboardTimeSeries.
aiplatform.tensorboardTimeSeries.update
(permission needed on the name
resource)
tensorboards.experiments.runs.timeSeries
Reads a TensorboardTimeSeries' data.
aiplatform.tensorboardTimeSeries.read
(permission needed on the tensorboardTimeSeries
resource)
tensorboards.experiments.runs.timeSeries
Gets bytes of TensorboardBlobs.
aiplatform.tensorboardTimeSeries.read
(permission needed on the timeSeries
resource)
trainingPipelines
Cancel a trainingPipeline
aiplatform.trainingPipelines.cancel
(permission needed on the name
resource)
trainingPipelines
Create a trainingPipeline
aiplatform.trainingPipelines.create
(permission needed on the parent
resource)
trainingPipelines
Delete a trainingPipeline
† † Starts a long-running operation
aiplatform.trainingPipelines.delete
(permission needed on the name
resource)
Other permissions:
aiplatform.trainingPipelines.get (to call GET on the long-running operation returned)
aiplatform.trainingPipelines.get (to call DELETE on the long-running operation returned)
aiplatform.trainingPipelines.get (to call WAIT on the long-running operation returned)
aiplatform.trainingPipelines.delete (to call CANCEL on the long-running operation returned)
trainingPipelines
Get a trainingPipeline
aiplatform.trainingPipelines.get
(permission needed on the name
resource)
trainingPipelines
List a trainingPipeline
aiplatform.trainingPipelines.list
(permission needed on the parent
resource)
N/A
Generic delete operation
† † Starts a long-running operation
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.locations.get (to call WAIT on the long-running operation returned)
aiplatform.locations.get (to call CANCEL on the long-running operation returned)
datasets
Delete data item operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
featurestores
Import features operation
† † Starts a long-running operation
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
aiplatform.featurestores.update (to call DELETE on the long-running operation returned)
aiplatform.featurestores.get (to call WAIT on the long-running operation returned)
aiplatform.featurestores.importFeatures (to call CANCEL on the long-running operation returned)
datasets
Delete annotation operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
datasets
Batch delete DataItems operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
datasets
Generate stats operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
datasets
Delete AnnotationSpec operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
hyperparameterTuningJobs
Delete HP tuning job
† † Starts a long-running operation
Other permissions:
aiplatform.hyperparameterTuningJobs.get (to call GET on the long-running operation returned)
aiplatform.hyperparameterTuningJobs.get (to call DELETE on the long-running operation returned)
aiplatform.hyperparameterTuningJobs.get (to call WAIT on the long-running operation returned)
aiplatform.hyperparameterTuningJobs.delete (to call CANCEL on the long-running operation returned)
nasJobs
Delete NAS job
† † Starts a long-running operation
Other permissions:
aiplatform.nasJobs.get (to call GET on the long-running operation returned)
aiplatform.nasJobs.get (to call DELETE on the long-running operation returned)
aiplatform.nasJobs.get (to call WAIT on the long-running operation returned)
aiplatform.nasJobs.delete (to call CANCEL on the long-running operation returned)
N/A
Create HumanInTheLoop operation
† † Starts a long-running operation
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.locations.get (to call WAIT on the long-running operation returned)
aiplatform.locations.get (to call CANCEL on the long-running operation returned)
featurestores
Export features operation
† † Starts a long-running operation
Other permissions:
aiplatform.featurestores.get (to call GET on the long-running operation returned)
N/A
Delete HumanInTheLoop operation
† † Starts a long-running operation
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
N/A
Send HumanInTheLoop entry operation
† † Starts a long-running operation
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
aiplatform.humanInTheLoops.send (to call CANCEL on the long-running operation returned)
datasets
Calculate data item label stats
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
N/A
Migrate resources operation
† † Starts a long-running operation
Other permissions:
aiplatform.locations.get (to call GET on the long-running operation returned)
aiplatform.locations.get (to call DELETE on the long-running operation returned)
datasets
Create DataItem operation
† † Starts a long-running operation
Other permissions:
aiplatform.datasets.get (to call GET on the long-running operation returned)
aiplatform.datasets.update (to call DELETE on the long-running operation returned)
aiplatform.datasets.get (to call WAIT on the long-running operation returned)
aiplatform.datasets.update (to call CANCEL on the long-running operation returned)
N/A
† † Starts a long-running operation
What's next
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-06-10 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2026-06-10 UTC."],[],[]]