Skip to main content

capabilities_region_presets

Creates, updates, deletes, gets or lists a capabilities_region_presets resource.

Overview​

Namecapabilities_region_presets
TypeResource
Idovh.cloud_ai.capabilities_region_presets

Fields​

The following fields are returned by SELECT queries:

successful operation

NameDatatypeDescription
idstringPreset id
namestringPreset name
capabilitiesobjectPreset capabilities
descriptionsarrayPreset description
doc_urlarrayURL toward the preset image documentation (wire: docUrl)
logo_urlstringURL toward the logo to illustrate the preset (wire: logoUrl)
partnerobjectPartner name
snippetstringSnippet example of the doc
typestringPreset type (app, job, notebook)

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectpreset_id, region, service_nameGet Preset Information
listselectregion, service_nametypeList Presets

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
api_hoststringThe OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
preset_idstringPreset ID (wire: presetId)
regionstringRegion
service_namestringThe Public Cloud project ID. Resolved from OVH_CLOUD_PROJECT_SERVICE when set.
typestringFilter on type of preset image

SELECT examples​

Get Preset Information

SELECT
id,
name,
capabilities,
descriptions,
doc_url,
logo_url,
partner,
snippet,
type
FROM ovh.cloud_ai.capabilities_region_presets
WHERE preset_id = '{{ preset_id }}' -- required
AND region = '{{ region }}' -- required
AND service_name = '{{ service_name }}' -- required unless OVH_CLOUD_PROJECT_SERVICE is set
;