Stay organized with collections
Save and categorize content based on your preferences.
This page shows you how to manage AML AI engine versions. An
engine version is used to control the architecture or setting for training and
running a model. It is a read-only resource.
For more information on engine versions,
see
Engine versions.
Before you begin
To get the permissions that
you need to manage engine versions,
ask your administrator to grant you the
Financial Services Admin (financialservices.admin)
IAM role on your project.
For more information about granting roles, see Manage access to projects, folders, and organizations.
[[["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 2025-08-29 UTC."],[[["\u003cp\u003eEngine versions manage the architecture and settings for training and running AML AI models, and are a read-only resource.\u003c/p\u003e\n"],["\u003cp\u003eTo manage engine versions, users need the Financial Services Admin (\u003ccode\u003efinancialservices.admin\u003c/code\u003e) IAM role on their project or other roles with equivalent permissions.\u003c/p\u003e\n"],["\u003cp\u003eYou can list the available engine versions using the \u003ccode\u003eprojects.locations.instances.engineVersions.list\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eYou can retrieve a specific engine version using the \u003ccode\u003eprojects.locations.instances.engineVersions.get\u003c/code\u003e method.\u003c/p\u003e\n"],["\u003cp\u003eTo perform these actions on an instance, you must replace the placeholder values like \u003ccode\u003ePROJECT_ID\u003c/code\u003e, \u003ccode\u003eLOCATION\u003c/code\u003e, \u003ccode\u003eINSTANCE_ID\u003c/code\u003e, and \u003ccode\u003eENGINE_VERSION_ID\u003c/code\u003e with actual data from your environment.\u003c/p\u003e\n"]]],[],null,["# Manage engine versions\n\nThis page shows you how to manage AML AI engine versions. An\nengine version is used to control the architecture or setting for training and\nrunning a model. It is a read-only resource.\n\nFor more information on engine versions,\nsee\n[Engine versions](/financial-services/anti-money-laundering/docs/reference/engine-versions).\n\nBefore you begin\n----------------\n\n-\n\n To get the permissions that\n you need to manage engine versions,\n\n ask your administrator to grant you the\n\n\n Financial Services Admin (`financialservices.admin`)\n IAM role on your project.\n\n\n For more information about granting roles, see [Manage access to projects, folders, and organizations](/iam/docs/granting-changing-revoking-access).\n\n\n You might also be able to get\n the required permissions through [custom\n roles](/iam/docs/creating-custom-roles) or other [predefined\n roles](/iam/docs/roles-overview#predefined).\n- [Create an instance](/financial-services/anti-money-laundering/docs/create-and-manage-instances#create-instance)\n\nList the engine versions\n------------------------\n\nTo list the engine versions, use the\n[`projects.locations.instances.engineVersions.list`](/financial-services/anti-money-laundering/docs/reference/rest/v1/projects.locations.instances.engineVersions/list)\nmethod.\n\n#### Permissions required for this task\n\nTo perform this task, you must have been granted the following permissions:\n\n**Permissions**\n\n- `financialservices.v1engineversions.list`\n\n\nBefore using any of the request data,\nmake the following replacements:\n\n- \u003cvar class=\"edit\" scope=\"PROJECT_ID\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: your Google Cloud project ID listed in the [IAM Settings](https://console.cloud.google.com/iam-admin/settings/project)\n- \u003cvar class=\"edit\" scope=\"LOCATION\" translate=\"no\"\u003eLOCATION\u003c/var\u003e: the location of the instance; use one of the [supported regions](/financial-services/anti-money-laundering/docs/locations) Show locations\n - `us-central1`\n - `us-east1`\n - `asia-south1`\n - `europe-west1`\n - `europe-west2`\n - `europe-west4`\n - `northamerica-northeast1`\n - `southamerica-east1`\n - `australia-southeast1`\n- \u003cvar class=\"edit\" scope=\"INSTANCE_ID\" translate=\"no\"\u003eINSTANCE_ID\u003c/var\u003e: the user-defined identifier for the instance\n\nTo send your request, choose one of these options: \n\n#### curl\n\n| **Note:** The following command assumes that you have logged in to the `gcloud` CLI with your user account by running [`gcloud init`](/sdk/gcloud/reference/init) or [`gcloud auth login`](/sdk/gcloud/reference/auth/login) , or by using [Cloud Shell](/shell/docs), which automatically logs you into the `gcloud` CLI . You can check the currently active account by running [`gcloud auth list`](/sdk/gcloud/reference/auth/list).\n\n\nExecute the following command:\n\n```\ncurl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n \"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions\"\n```\n\n#### PowerShell\n\n| **Note:** The following command assumes that you have logged in to the `gcloud` CLI with your user account by running [`gcloud init`](/sdk/gcloud/reference/init) or [`gcloud auth login`](/sdk/gcloud/reference/auth/login) . You can check the currently active account by running [`gcloud auth list`](/sdk/gcloud/reference/auth/list).\n\n\nExecute the following command:\n\n```\n$cred = gcloud auth print-access-token\n$headers = @{ \"Authorization\" = \"Bearer $cred\" }\n\nInvoke-WebRequest `\n -Method GET `\n -Headers $headers `\n -Uri \"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions\" | Select-Object -Expand Content\n```\n\nYou should receive a JSON response similar to the following:\n\n```\n{\n \"engineVersions\": [\n {\n \"name\": \"projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/finserv-aml.live-with-data-validation.v1.1.2022-05\",\n \"state\": \"ACTIVE\",\n \"expectedLimitationStartTime\": EXPECTED_LIMITATION_START_TIME,\n \"expectedDecommissionTime\": \"EXPECTED_DECOMMISSION_TIME,\n \"lineOfBusiness\": \"RETAIL\"\n },\n {\n \"name\": \"projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/finserv-aml.live.v1.1.2022-05\",\n \"state\": \"ACTIVE\",\n \"expectedLimitationStartTime\": EXPECTED_LIMITATION_START_TIME,\n \"expectedDecommissionTime\": \"EXPECTED_DECOMMISSION_TIME,\n \"lineOfBusiness\": \"RETAIL\"\n }\n ]\n}\n```\n\nGet an engine version\n---------------------\n\nTo get an engine version, use the\n[`projects.locations.instances.engineVersions.get`](/financial-services/anti-money-laundering/docs/reference/rest/v1/projects.locations.instances.engineVersions/get)\nmethod.\n\n#### Permissions required for this task\n\nTo perform this task, you must have been granted the following permissions:\n\n**Permissions**\n\n- `financialservices.v1engineversions.get`\n\n\nBefore using any of the request data,\nmake the following replacements:\n\n- \u003cvar class=\"edit\" scope=\"PROJECT_ID\" translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: your Google Cloud project ID listed in the [IAM Settings](https://console.cloud.google.com/iam-admin/settings/project)\n- \u003cvar class=\"edit\" scope=\"LOCATION\" translate=\"no\"\u003eLOCATION\u003c/var\u003e: the location of the instance; use one of the [supported regions](/financial-services/anti-money-laundering/docs/locations) Show locations\n - `us-central1`\n - `us-east1`\n - `asia-south1`\n - `europe-west1`\n - `europe-west2`\n - `europe-west4`\n - `northamerica-northeast1`\n - `southamerica-east1`\n - `australia-southeast1`\n- \u003cvar class=\"edit\" scope=\"INSTANCE_ID\" translate=\"no\"\u003eINSTANCE_ID\u003c/var\u003e: the user-defined identifier for the instance\n- \u003cvar class=\"edit\" scope=\"ENGINE_VERSION_ID\" translate=\"no\"\u003eENGINE_VERSION_ID\u003c/var\u003e: the identifier for the engine version\n\nTo send your request, choose one of these options: \n\n#### curl\n\n| **Note:** The following command assumes that you have logged in to the `gcloud` CLI with your user account by running [`gcloud init`](/sdk/gcloud/reference/init) or [`gcloud auth login`](/sdk/gcloud/reference/auth/login) , or by using [Cloud Shell](/shell/docs), which automatically logs you into the `gcloud` CLI . You can check the currently active account by running [`gcloud auth list`](/sdk/gcloud/reference/auth/list).\n\n\nExecute the following command:\n\n```\ncurl -X GET \\\n -H \"Authorization: Bearer $(gcloud auth print-access-token)\" \\\n \"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID\"\n```\n\n#### PowerShell\n\n| **Note:** The following command assumes that you have logged in to the `gcloud` CLI with your user account by running [`gcloud init`](/sdk/gcloud/reference/init) or [`gcloud auth login`](/sdk/gcloud/reference/auth/login) . You can check the currently active account by running [`gcloud auth list`](/sdk/gcloud/reference/auth/list).\n\n\nExecute the following command:\n\n```\n$cred = gcloud auth print-access-token\n$headers = @{ \"Authorization\" = \"Bearer $cred\" }\n\nInvoke-WebRequest `\n -Method GET `\n -Headers $headers `\n -Uri \"https://financialservices.googleapis.com/v1/projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID\" | Select-Object -Expand Content\n```\n\nYou should receive a JSON response similar to the following:\n\n```\n{\n \"name\": \"projects/PROJECT_ID/locations/LOCATION/instances/INSTANCE_ID/engineVersions/ENGINE_VERSION_ID\",\n \"state\": \"ACTIVE\",\n \"expectedLimitationStartTime\": EXPECTED_LIMITATION_START_TIME,\n \"expectedDecommissionTime\": \"EXPECTED_DECOMMISSION_TIME,\n \"lineOfBusiness\": \"RETAIL\"\n}\n```"]]
