index int64 0 731k | package stringlengths 2 98 ⌀ | name stringlengths 1 76 | docstring stringlengths 0 281k ⌀ | code stringlengths 4 8.19k | signature stringlengths 2 42.8k ⌀ | embed_func_code listlengths 768 768 |
|---|---|---|---|---|---|---|
719,390 | ibm_platform_services.catalog_management_v1 | list_objects |
List objects within a catalog.
List the available objects within the specified catalog.
:param str catalog_identifier: Catalog identifier.
:param int limit: (optional) The number of results to return.
:param int offset: (optional) The number of results to skip before
... | def list_objects(
self,
catalog_identifier: str,
*,
limit: int = None,
offset: int = None,
name: str = None,
sort: str = None,
**kwargs
) -> DetailedResponse:
"""
List objects within a catalog.
List the available objects within the specified catalog.
:param str catalog_id... | (self, catalog_identifier: str, *, limit: Optional[int] = None, offset: Optional[int] = None, name: Optional[str] = None, sort: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.037998951971530914,
-0.03160660341382027,
-0.03906434401869774,
-0.06182819977402687,
0.0367559939622879,
0.03735971823334694,
-0.025498362258076668,
0.00403072964400053,
0.0021940399892628193,
-0.04009421914815903,
-0.037714846432209015,
0.011097824200987816,
-0.0009999140165746212,
-0... |
719,391 | ibm_platform_services.catalog_management_v1 | list_offerings |
Get list of offerings.
Retrieve the available offerings in the specified catalog. This can also be used
by an unauthenticated user to retreive publicly available offerings.
:param str catalog_identifier: Catalog identifier.
:param bool digest: (optional) true - Strip down the ... | def list_offerings(
self,
catalog_identifier: str,
*,
digest: bool = None,
limit: int = None,
offset: int = None,
name: str = None,
sort: str = None,
**kwargs
) -> DetailedResponse:
"""
Get list of offerings.
Retrieve the available offerings in the specified catalog. This... | (self, catalog_identifier: str, *, digest: Optional[bool] = None, limit: Optional[int] = None, offset: Optional[int] = None, name: Optional[str] = None, sort: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.031722359359264374,
-0.05380984768271446,
-0.04275701195001602,
-0.06209947168827057,
0.005426432006061077,
0.033122140914201736,
0.011543666012585163,
-0.061372309923172,
-0.05675484612584114,
-0.026159584522247314,
-0.054282501339912415,
-0.017406394705176353,
-0.026541342958807945,
0... |
719,392 | ibm_platform_services.catalog_management_v1 | list_operators |
List operators.
List the operators from a kubernetes cluster.
:param str x_auth_refresh_token: IAM Refresh token.
:param str cluster_id: Cluster identification.
:param str region: Cluster region.
:param str version_locator_id: A dotted value of `catalogID`.`versionID`.... | def list_operators(
self, x_auth_refresh_token: str, cluster_id: str, region: str, version_locator_id: str, **kwargs
) -> DetailedResponse:
"""
List operators.
List the operators from a kubernetes cluster.
:param str x_auth_refresh_token: IAM Refresh token.
:param str cluster_id: Cluster identif... | (self, x_auth_refresh_token: str, cluster_id: str, region: str, version_locator_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.03291619196534157,
-0.08628551661968231,
-0.0244752187281847,
-0.05068191885948181,
0.024835944175720215,
0.029020357877016068,
-0.026495281606912613,
-0.0016458096215501428,
-0.04299846664071083,
0.05180016905069351,
0.02025473117828369,
-0.0372629351913929,
0.019659534096717834,
-0.057... |
719,393 | ibm_platform_services.catalog_management_v1 | preinstall_version |
Pre-install version.
Create a pre-install for the specified version.
:param str version_loc_id: A dotted value of `catalogID`.`versionID`.
:param str x_auth_refresh_token: IAM Refresh token.
:param str cluster_id: (optional) Cluster ID.
:param str region: (optional) Cl... | def preinstall_version(
self,
version_loc_id: str,
x_auth_refresh_token: str,
*,
cluster_id: str = None,
region: str = None,
namespace: str = None,
override_values: dict = None,
entitlement_apikey: str = None,
schematics: 'DeployRequestBodySchematics' = None,
script: str = No... | (self, version_loc_id: str, x_auth_refresh_token: str, *, cluster_id: Optional[str] = None, region: Optional[str] = None, namespace: Optional[str] = None, override_values: Optional[dict] = None, entitlement_apikey: Optional[str] = None, schematics: Optional[ibm_platform_services.catalog_management_v1.DeployRequestBodyS... | [
-0.001557659008540213,
-0.041126057505607605,
-0.0838724672794342,
0.004918923135846853,
0.027295202016830444,
-0.002768100006505847,
-0.014467420987784863,
0.03533908724784851,
-0.028433306142687798,
0.03288927301764488,
0.005434927996248007,
-0.016743628308176994,
-0.032657790929079056,
... |
719,395 | ibm_platform_services.catalog_management_v1 | public_publish_object |
Publish object to share with all users.
Publish the specified object so it is visible to all users in the public catalog.
:param str catalog_identifier: Catalog identifier.
:param str object_identifier: Object identifier.
:param dict headers: A `dict` containing the request he... | def public_publish_object(self, catalog_identifier: str, object_identifier: str, **kwargs) -> DetailedResponse:
"""
Publish object to share with all users.
Publish the specified object so it is visible to all users in the public catalog.
:param str catalog_identifier: Catalog identifier.
:param str ... | (self, catalog_identifier: str, object_identifier: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0710199624300003,
0.0009552909759804606,
-0.09099214524030685,
-0.011374018155038357,
0.0671442449092865,
-0.012369136326014996,
-0.004159416537731886,
0.012107263319194317,
-0.04043319448828697,
-0.0037840651348233223,
-0.0033694328740239143,
0.022748036310076714,
0.050209786742925644,
... |
719,396 | ibm_platform_services.catalog_management_v1 | public_publish_version |
Publish version to all users in public catalog.
Publish the specified version so it is visible to all users in the public catalog.
:param str version_loc_id: A dotted value of `catalogID`.`versionID`.
:param dict headers: A `dict` containing the request headers
:return: A `Det... | def public_publish_version(self, version_loc_id: str, **kwargs) -> DetailedResponse:
"""
Publish version to all users in public catalog.
Publish the specified version so it is visible to all users in the public catalog.
:param str version_loc_id: A dotted value of `catalogID`.`versionID`.
:param dic... | (self, version_loc_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.03949884697794914,
-0.04967067390680313,
-0.07284566015005112,
0.0029121660627424717,
0.021741842851042747,
-0.011849653907120228,
-0.019766900688409805,
0.03311960771679878,
-0.0028553646989166737,
0.024887768551707268,
-0.04072226211428642,
0.004133397247642279,
0.02633839100599289,
-... |
719,397 | ibm_platform_services.catalog_management_v1 | put_offering_instance |
Update Offering Instance.
Update an installed offering instance.
:param str instance_identifier: Version Instance identifier.
:param str x_auth_refresh_token: IAM Refresh token.
:param str id: (optional) provisioned instance ID (part of the CRN).
:param str rev: (optio... | def put_offering_instance(
self,
instance_identifier: str,
x_auth_refresh_token: str,
*,
id: str = None,
rev: str = None,
url: str = None,
crn: str = None,
label: str = None,
catalog_id: str = None,
offering_id: str = None,
kind_format: str = None,
version: str = None... | (self, instance_identifier: str, x_auth_refresh_token: str, *, id: Optional[str] = None, rev: Optional[str] = None, url: Optional[str] = None, crn: Optional[str] = None, label: Optional[str] = None, catalog_id: Optional[str] = None, offering_id: Optional[str] = None, kind_format: Optional[str] = None, version: Optional... | [
0.04649950936436653,
-0.08477563410997391,
-0.05162043496966362,
-0.031809549778699875,
-0.014867507852613926,
-0.01633463427424431,
0.0359773114323616,
-0.02248348481953144,
-0.055619992315769196,
0.02814640663564205,
-0.035416629165410995,
-0.045677170157432556,
0.017998000606894493,
0.0... |
719,398 | ibm_platform_services.catalog_management_v1 | reload_offering |
Reload offering.
Reload an existing version in offering from a tgz.
:param str catalog_identifier: Catalog identifier.
:param str offering_id: Offering identification.
:param str target_version: The semver value for this new version.
:param List[str] tags: (optional) T... | def reload_offering(
self,
catalog_identifier: str,
offering_id: str,
target_version: str,
*,
tags: List[str] = None,
target_kinds: List[str] = None,
content: bytes = None,
zipurl: str = None,
repo_type: str = None,
**kwargs
) -> DetailedResponse:
"""
Reload offering.... | (self, catalog_identifier: str, offering_id: str, target_version: str, *, tags: Optional[List[str]] = None, target_kinds: Optional[List[str]] = None, content: Optional[bytes] = None, zipurl: Optional[str] = None, repo_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.009552150964736938,
-0.06986180692911148,
-0.07248396426439285,
-0.04319070652127266,
-0.004392116330564022,
-0.019291598349809647,
0.007843065075576305,
0.03530550003051758,
-0.05854906514286995,
-0.004656673409044743,
-0.025341294705867767,
-0.04472653940320015,
-0.01841130293905735,
0... |
719,399 | ibm_platform_services.catalog_management_v1 | replace_catalog |
Update catalog.
Update a catalog.
:param str catalog_identifier: Catalog identifier.
:param str id: (optional) Unique ID.
:param str rev: (optional) Cloudant revision.
:param str label: (optional) Display Name in the requested language.
:param str short_descrip... | def replace_catalog(
self,
catalog_identifier: str,
*,
id: str = None,
rev: str = None,
label: str = None,
short_description: str = None,
catalog_icon_url: str = None,
tags: List[str] = None,
features: List['Feature'] = None,
disabled: bool = None,
resource_group_id: str ... | (self, catalog_identifier: str, *, id: Optional[str] = None, rev: Optional[str] = None, label: Optional[str] = None, short_description: Optional[str] = None, catalog_icon_url: Optional[str] = None, tags: Optional[List[str]] = None, features: Optional[List[ibm_platform_services.catalog_management_v1.Feature]] = None, di... | [
-0.011561925522983074,
-0.0512370839715004,
-0.030070602893829346,
-0.04578714445233345,
0.027902141213417053,
-0.01130286231637001,
-0.012070458382368088,
0.05634159967303276,
0.041757263243198395,
-0.023392511531710625,
-0.053117696195840836,
0.0008653454133309424,
-0.033582355827093124,
... |
719,400 | ibm_platform_services.catalog_management_v1 | replace_object |
Update catalog object.
Update an object within a specific catalog.
:param str catalog_identifier: Catalog identifier.
:param str object_identifier: Object identifier.
:param str id: (optional) unique id.
:param str name: (optional) The programmatic name of this offerin... | def replace_object(
self,
catalog_identifier: str,
object_identifier: str,
*,
id: str = None,
name: str = None,
rev: str = None,
crn: str = None,
url: str = None,
parent_id: str = None,
label_i18n: str = None,
label: str = None,
tags: List[str] = None,
created: da... | (self, catalog_identifier: str, object_identifier: str, *, id: Optional[str] = None, name: Optional[str] = None, rev: Optional[str] = None, crn: Optional[str] = None, url: Optional[str] = None, parent_id: Optional[str] = None, label_i18n: Optional[str] = None, label: Optional[str] = None, tags: Optional[List[str]] = No... | [
-0.014732340350747108,
-0.04379620775580406,
-0.09165920317173004,
-0.04129356890916824,
0.029581991955637932,
-0.04473469778895378,
-0.001641135779209435,
0.05423691123723984,
0.015318896621465683,
-0.03636649250984192,
-0.043913520872592926,
-0.00791851058602333,
-0.007463929709047079,
0... |
719,401 | ibm_platform_services.catalog_management_v1 | replace_offering |
Update offering.
Update an offering.
:param str catalog_identifier: Catalog identifier.
:param str offering_id: Offering identification.
:param str id: (optional) unique id.
:param str rev: (optional) Cloudant revision.
:param str url: (optional) The url for th... | def replace_offering(
self,
catalog_identifier: str,
offering_id: str,
*,
id: str = None,
rev: str = None,
url: str = None,
crn: str = None,
label: str = None,
name: str = None,
offering_icon_url: str = None,
offering_docs_url: str = None,
offering_support_url: str = ... | (self, catalog_identifier: str, offering_id: str, *, id: Optional[str] = None, rev: Optional[str] = None, url: Optional[str] = None, crn: Optional[str] = None, label: Optional[str] = None, name: Optional[str] = None, offering_icon_url: Optional[str] = None, offering_docs_url: Optional[str] = None, offering_support_url:... | [
-0.0066302926279604435,
-0.0841279849410057,
-0.06425677984952927,
-0.008971553295850754,
-0.008007504977285862,
-0.03936859220266342,
0.020658181980252266,
-0.002215835964307189,
-0.020972972735762596,
0.010525835677981377,
-0.05020921677350998,
-0.009970031678676605,
-0.011066882871091366,... |
719,402 | ibm_platform_services.catalog_management_v1 | replace_offering_icon |
Upload icon for offering.
Upload an icon file to be stored in GC. File is uploaded as a binary payload - not
as a form.
:param str catalog_identifier: Catalog identifier.
:param str offering_id: Offering identification.
:param str file_name: Name of the file name that ... | def replace_offering_icon(
self, catalog_identifier: str, offering_id: str, file_name: str, **kwargs
) -> DetailedResponse:
"""
Upload icon for offering.
Upload an icon file to be stored in GC. File is uploaded as a binary payload - not
as a form.
:param str catalog_identifier: Catalog identifie... | (self, catalog_identifier: str, offering_id: str, file_name: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.007079399656504393,
-0.09537051618099213,
-0.048401255160570145,
0.011617016978561878,
-0.02031635493040085,
-0.04546567425131798,
0.018096771091222763,
0.029248392209410667,
0.01435569766908884,
-0.016566332429647446,
0.012449361383914948,
-0.031414274126291275,
0.004591317381709814,
-0... |
719,403 | ibm_platform_services.catalog_management_v1 | replace_operators |
Update operators.
Update the operators on a kubernetes cluster.
:param str x_auth_refresh_token: IAM Refresh token.
:param str cluster_id: (optional) Cluster ID.
:param str region: (optional) Cluster region.
:param List[str] namespaces: (optional) Kube namespaces to de... | def replace_operators(
self,
x_auth_refresh_token: str,
*,
cluster_id: str = None,
region: str = None,
namespaces: List[str] = None,
all_namespaces: bool = None,
version_locator_id: str = None,
**kwargs
) -> DetailedResponse:
"""
Update operators.
Update the operators on ... | (self, x_auth_refresh_token: str, *, cluster_id: Optional[str] = None, region: Optional[str] = None, namespaces: Optional[List[str]] = None, all_namespaces: Optional[bool] = None, version_locator_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.044269222766160965,
-0.09547532349824905,
-0.03841390088200569,
-0.04650692641735077,
-0.0033215901348739862,
-0.0061630066484212875,
-0.05299626290798187,
-0.02013932541012764,
-0.04162127524614334,
0.05467453971505165,
0.022656742483377457,
-0.050870444625616074,
0.03986840695142746,
-... |
719,404 | ibm_platform_services.catalog_management_v1 | search_objects |
List objects across catalogs.
List the available objects from both public and private catalogs. These copies
cannot be used for updating. They are not complete and only return what is visible
to the caller.
:param str query: Lucene query string.
:param int limit: (opti... | def search_objects(
self, query: str, *, limit: int = None, offset: int = None, collapse: bool = None, digest: bool = None, **kwargs
) -> DetailedResponse:
"""
List objects across catalogs.
List the available objects from both public and private catalogs. These copies
cannot be used for updating. Th... | (self, query: str, *, limit: Optional[int] = None, offset: Optional[int] = None, collapse: Optional[bool] = None, digest: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.02754492126405239,
-0.033709898591041565,
-0.07933761179447174,
-0.0421760119497776,
0.03034406155347824,
0.036406002938747406,
0.008603494614362717,
-0.053853411227464676,
0.005521005019545555,
-0.009410608559846878,
-0.02848941646516323,
0.02682366967201233,
0.010286413133144379,
-0.0... |
719,407 | ibm_platform_services.catalog_management_v1 | set_deprecate_version |
Sets version to be deprecated in a certain time period.
Set or cancel the version to be deprecated.
:param str version_loc_id: A dotted value of `catalogID`.`versionID`.
:param str setting: Set deprecation (true) or cancel deprecation (false).
:param str description: (optional... | def set_deprecate_version(
self, version_loc_id: str, setting: str, *, description: str = None, days_until_deprecate: int = None, **kwargs
) -> DetailedResponse:
"""
Sets version to be deprecated in a certain time period.
Set or cancel the version to be deprecated.
:param str version_loc_id: A dotte... | (self, version_loc_id: str, setting: str, *, description: Optional[str] = None, days_until_deprecate: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.012345255352556705,
-0.02995634637773037,
-0.01332109235227108,
-0.013302680104970932,
-0.0033670971170067787,
-0.028170380741357803,
-0.04510943591594696,
0.049344196915626526,
-0.0014672073302790523,
0.0064580137841403484,
-0.05037527158856392,
-0.028906861320137978,
0.016791757196187973... |
719,413 | ibm_platform_services.catalog_management_v1 | shared_publish_object |
Publish object to share with allow list.
Publish the specified object so that it is visible to those in the allow list.
:param str catalog_identifier: Catalog identifier.
:param str object_identifier: Object identifier.
:param dict headers: A `dict` containing the request head... | def shared_publish_object(self, catalog_identifier: str, object_identifier: str, **kwargs) -> DetailedResponse:
"""
Publish object to share with allow list.
Publish the specified object so that it is visible to those in the allow list.
:param str catalog_identifier: Catalog identifier.
:param str ob... | (self, catalog_identifier: str, object_identifier: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.043812043964862823,
-0.004780450835824013,
-0.11389029771089554,
0.0027360639069229364,
0.05169190838932991,
-0.015173115767538548,
-0.013956114649772644,
0.031151728704571724,
-0.03367328643798828,
-0.019734680652618408,
-0.016503937542438507,
0.010734125971794128,
0.019349442794919014,
... |
719,414 | ibm_platform_services.catalog_management_v1 | update_catalog_account |
Update account settings.
Update the account level settings for the account for private catalog.
:param str id: (optional) Account identification.
:param bool hide_ibm_cloud_catalog: (optional) Hide the public catalog in
this account.
:param Filters account_filte... | def update_catalog_account(
self, *, id: str = None, hide_ibm_cloud_catalog: bool = None, account_filters: 'Filters' = None, **kwargs
) -> DetailedResponse:
"""
Update account settings.
Update the account level settings for the account for private catalog.
:param str id: (optional) Account identific... | (self, *, id: Optional[str] = None, hide_ibm_cloud_catalog: Optional[bool] = None, account_filters: Optional[ibm_platform_services.catalog_management_v1.Filters] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04191998019814491,
-0.043426305055618286,
0.03042045794427395,
-0.001119412248954177,
0.008665972389280796,
-0.015348002314567566,
-0.011453595943748951,
-0.017680972814559937,
0.0046705324202775955,
-0.008946113288402557,
-0.03381887823343277,
-0.056138236075639725,
-0.005616579204797745... |
719,415 | ibm_platform_services.catalog_management_v1 | update_offering |
Update offering.
Update an offering.
:param str catalog_identifier: Catalog identifier.
:param str offering_id: Offering identification.
:param str if_match: Offering etag contained in quotes.
:param List[JsonPatchOperation] updates: (optional)
:param dict head... | def update_offering(
self,
catalog_identifier: str,
offering_id: str,
if_match: str,
*,
updates: List['JsonPatchOperation'] = None,
**kwargs
) -> DetailedResponse:
"""
Update offering.
Update an offering.
:param str catalog_identifier: Catalog identifier.
:param str offer... | (self, catalog_identifier: str, offering_id: str, if_match: str, *, updates: Optional[List[ibm_platform_services.catalog_management_v1.JsonPatchOperation]] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.013734622858464718,
-0.06636391580104828,
-0.07018475979566574,
-0.03709553927183151,
-0.021663794293999672,
-0.04358725622296333,
0.007952355779707432,
-0.02661604806780815,
-0.057943232357501984,
0.006598368752747774,
-0.042437296360731125,
-0.05979800596833229,
0.01894654519855976,
0.... |
719,416 | ibm_platform_services.catalog_management_v1 | update_offering_ibm |
Allow offering to be published.
Approve or disapprove the offering to be allowed to publish to the IBM Public
Catalog. Options:
* `allow_request` - (Allow requesting to publish to IBM)
* `ibm` - (Allow publishing to be visible to IBM only)
* `public` - (Allow publishing... | def update_offering_ibm(
self, catalog_identifier: str, offering_id: str, approval_type: str, approved: str, **kwargs
) -> DetailedResponse:
"""
Allow offering to be published.
Approve or disapprove the offering to be allowed to publish to the IBM Public
Catalog. Options:
* `allow_request` - (Al... | (self, catalog_identifier: str, offering_id: str, approval_type: str, approved: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0020168395712971687,
-0.03766002133488655,
-0.02226627990603447,
0.00919734500348568,
0.018737390637397766,
-0.05623995512723923,
0.0034200598020106554,
-0.012874430045485497,
-0.04479190334677696,
0.023618558421730995,
-0.029435208067297935,
-0.026434261351823807,
-0.015792015939950943,
... |
719,417 | ibm_platform_services.catalog_management_v1 | validate_install |
Validate offering.
Validate the offering associated with the specified version.
:param str version_loc_id: A dotted value of `catalogID`.`versionID`.
:param str x_auth_refresh_token: IAM Refresh token.
:param str cluster_id: (optional) Cluster ID.
:param str region: (o... | def validate_install(
self,
version_loc_id: str,
x_auth_refresh_token: str,
*,
cluster_id: str = None,
region: str = None,
namespace: str = None,
override_values: dict = None,
entitlement_apikey: str = None,
schematics: 'DeployRequestBodySchematics' = None,
script: str = None... | (self, version_loc_id: str, x_auth_refresh_token: str, *, cluster_id: Optional[str] = None, region: Optional[str] = None, namespace: Optional[str] = None, override_values: Optional[dict] = None, entitlement_apikey: Optional[str] = None, schematics: Optional[ibm_platform_services.catalog_management_v1.DeployRequestBodyS... | [
0.026194630190730095,
-0.039018675684928894,
-0.059025753289461136,
-0.0022703150752931833,
-0.000879579340107739,
-0.015107781626284122,
-0.009944980964064598,
0.009808346629142761,
-0.06577935814857483,
0.057503264397382736,
0.008710397407412529,
0.005094484426081181,
0.009818105958402157,... |
719,425 | ibm_platform_services.enterprise_billing_units_v1 | EnterpriseBillingUnitsV1 | The Enterprise Billing Units V1 service. | class EnterpriseBillingUnitsV1(BaseService):
"""The Enterprise Billing Units V1 service."""
DEFAULT_SERVICE_URL = 'https://billing.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'enterprise_billing_units'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) ->... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.018446289002895355,
-0.03426632657647133,
-0.03993569687008858,
-0.0482730008661747,
-0.013287581503391266,
-0.0035407496616244316,
-0.04489639401435852,
-0.030431166291236877,
-0.04910673201084137,
-0.045938555151224136,
-0.01728948764503002,
-0.024657582864165306,
0.02116633579134941,
... |
719,426 | ibm_platform_services.enterprise_billing_units_v1 | __init__ |
Construct a new client for the Enterprise Billing Units service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Enterprise Billing Units service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/pyt... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.0035721983294934034,
-0.06950510293245316,
-0.006266853306442499,
-0.01699952781200409,
-0.028724608942866325,
-0.04616520553827286,
-0.020987525582313538,
0.007516548503190279,
-0.03896108269691467,
-0.013792590238153934,
-0.0007155882776714861,
0.008527331054210663,
-0.05814757570624351... |
719,436 | ibm_platform_services.enterprise_billing_units_v1 | get_billing_unit |
Get billing unit by ID.
Return the billing unit information if it exists.
:param str billing_unit_id: The ID of the requested billing unit.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status... | def get_billing_unit(self, billing_unit_id: str, **kwargs) -> DetailedResponse:
"""
Get billing unit by ID.
Return the billing unit information if it exists.
:param str billing_unit_id: The ID of the requested billing unit.
:param dict headers: A `dict` containing the request headers
:return: A ... | (self, billing_unit_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0016810392262414098,
0.008011378347873688,
0.016922911629080772,
-0.02217981591820717,
-0.0010931255528703332,
-0.023602060973644257,
-0.019137293100357056,
0.027490729466080666,
-0.04306340962648392,
-0.06931192427873611,
-0.004874338861554861,
-0.0067511615343391895,
0.01654484681785106... |
719,437 | ibm_platform_services.enterprise_billing_units_v1 | get_credit_pools |
Get credit pools.
Get credit pools for a billing unit. Credit pools can be either platform or
support credit pools. The platform credit pool contains credit from platform
subscriptions and promotional offers. The support credit pool contains credit from
support subscriptions.
... | def get_credit_pools(
self,
billing_unit_id: str,
*,
date: str = None,
type: str = None,
limit: int = None,
start: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get credit pools.
Get credit pools for a billing unit. Credit pools can be either platform or
support credit... | (self, billing_unit_id: str, *, date: Optional[str] = None, type: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.05256408080458641,
0.00147065962664783,
-0.007325381506234407,
-0.03269621357321739,
-0.023727089166641235,
0.04405948892235756,
-0.02413802593946457,
-0.020296666771173477,
-0.03944985941052437,
-0.01482049748301506,
-0.015392234548926353,
-0.013310753740370274,
-0.0037341578863561153,
... |
719,440 | ibm_platform_services.enterprise_billing_units_v1 | list_billing_options |
List billing options.
Return matching billing options if any exist. Show subscriptions and promotional
offers that are available to a billing unit.
:param str billing_unit_id: The billing unit ID.
:param int limit: (optional) Return results up to this limit. Valid values
... | def list_billing_options(
self, billing_unit_id: str, *, limit: int = None, start: str = None, **kwargs
) -> DetailedResponse:
"""
List billing options.
Return matching billing options if any exist. Show subscriptions and promotional
offers that are available to a billing unit.
:param str billin... | (self, billing_unit_id: str, *, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.026706280186772346,
-0.018111972138285637,
0.024042755365371704,
-0.07294508069753647,
-0.019514761865139008,
0.04357527568936348,
-0.02359883487224579,
-0.03334733843803406,
-0.057248037308454514,
-0.04041455686092377,
-0.03258379548788071,
-0.023900700733065605,
0.009118135087192059,
... |
719,441 | ibm_platform_services.enterprise_billing_units_v1 | list_billing_units |
List billing units.
Return matching billing unit information if any exists. Omits internal properties
and enterprise account ID from the billing unit.
:param str account_id: (optional) The enterprise account ID.
:param str enterprise_id: (optional) The enterprise ID.
:... | def list_billing_units(
self,
*,
account_id: str = None,
enterprise_id: str = None,
account_group_id: str = None,
limit: int = None,
start: str = None,
**kwargs,
) -> DetailedResponse:
"""
List billing units.
Return matching billing unit information if any exists. Omits inter... | (self, *, account_id: Optional[str] = None, enterprise_id: Optional[str] = None, account_group_id: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04377344995737076,
0.0240448247641325,
-0.023846998810768127,
-0.06657736748456955,
-0.037191249430179596,
0.04636317119002342,
-0.04114776477217674,
-0.041795194149017334,
-0.09035243093967438,
-0.03577049821615219,
-0.002511038677766919,
-0.031130585819482803,
0.007629781030118465,
-0... |
719,450 | ibm_platform_services.enterprise_management_v1 | EnterpriseManagementV1 | The Enterprise Management V1 service. | class EnterpriseManagementV1(BaseService):
"""The Enterprise Management V1 service."""
DEFAULT_SERVICE_URL = 'https://enterprise.cloud.ibm.com/v1'
DEFAULT_SERVICE_NAME = 'enterprise_management'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> '... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
-0.000034552038414403796,
-0.046238064765930176,
-0.05589306354522705,
-0.03723488375544548,
0.03153150901198387,
-0.0371941439807415,
-0.033568426966667175,
-0.0492527037858963,
-0.06053723767399788,
-0.0006511776009574533,
0.00735837034881115,
-0.04236792027950287,
-0.016712922602891922,
... |
719,451 | ibm_platform_services.enterprise_management_v1 | __init__ |
Construct a new client for the Enterprise Management service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the au... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Enterprise Management service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.000768511148635298,
-0.06732480227947235,
0.016047710552811623,
-0.012388353236019611,
0.005392252001911402,
-0.05187623202800751,
-0.0011913650669157505,
0.02429739572107792,
-0.023412514477968216,
0.0065628779120743275,
-0.015909448266029358,
0.006111219059675932,
-0.0483366996049881,
... |
719,457 | ibm_platform_services.enterprise_management_v1 | create_account |
Create a new account in an enterprise.
Create a new account as a part of an existing enterprise. The API creates an
account entity under the parent that is specified in the payload of the request.
The request also takes in the name and the owner of this new account. The owner
m... | def create_account(
self,
parent: str,
name: str,
owner_iam_id: str,
*,
traits: Optional['CreateAccountRequestTraits'] = None,
options: Optional['CreateAccountRequestOptions'] = None,
**kwargs,
) -> DetailedResponse:
"""
Create a new account in an enterprise.
Create a new acc... | (self, parent: str, name: str, owner_iam_id: str, *, traits: Optional[ibm_platform_services.enterprise_management_v1.CreateAccountRequestTraits] = None, options: Optional[ibm_platform_services.enterprise_management_v1.CreateAccountRequestOptions] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedRespons... | [
-0.07654479146003723,
-0.006573166232556105,
-0.009852397255599499,
-0.05682039260864258,
-0.010023956187069416,
-0.03166491910815239,
-0.022822268307209015,
-0.029174858704209328,
-0.02174389734864235,
-0.04442891851067543,
0.0804661437869072,
-0.0030709088314324617,
0.023508505895733833,
... |
719,458 | ibm_platform_services.enterprise_management_v1 | create_account_group |
Create an account group.
Create a new account group, which can be used to group together multiple accounts.
To create an account group, you must have an existing enterprise. The API creates
an account group entity under the parent that is specified in the payload of the
request... | def create_account_group(
self,
parent: str,
name: str,
primary_contact_iam_id: str,
**kwargs,
) -> DetailedResponse:
"""
Create an account group.
Create a new account group, which can be used to group together multiple accounts.
To create an account group, you must have an existing ... | (self, parent: str, name: str, primary_contact_iam_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.09416267275810242,
0.023893963545560837,
-0.0433996208012104,
-0.050093647092580795,
0.006215219851583242,
-0.06095284968614578,
-0.03393500670790672,
0.022108890116214752,
0.010264177806675434,
-0.028616972267627716,
0.056638918817043304,
0.012523411773145199,
0.03949476778507233,
-0.0... |
719,459 | ibm_platform_services.enterprise_management_v1 | create_enterprise |
Create an enterprise.
Create a new enterprise, which you can use to centrally manage multiple accounts.
To create an enterprise, you must have an active Subscription account.
<br/><br/>The API creates an enterprise entity, which is the root of the
enterprise hierarchy. It also ... | def create_enterprise(
self,
source_account_id: str,
name: str,
primary_contact_iam_id: str,
*,
domain: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Create an enterprise.
Create a new enterprise, which you can use to centrally manage multiple accounts.
To create... | (self, source_account_id: str, name: str, primary_contact_iam_id: str, *, domain: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.049620382487773895,
-0.014658038504421711,
0.0012782904086634517,
-0.050695858895778656,
0.005785335786640644,
-0.045578062534332275,
-0.05703747645020485,
-0.025959840044379234,
-0.04179534316062927,
-0.010393207892775536,
0.04657937213778496,
-0.017921561375260353,
0.015140149742364883,... |
719,460 | ibm_platform_services.enterprise_management_v1 | delete_account |
Remove an account from its enterprise.
Remove an account from the enterprise its currently in. After an account is
removed, it will be canceled and cannot be reactivated.
:param str account_id: The ID of the target account.
:param dict headers: A `dict` containing the request ... | def delete_account(
self,
account_id: str,
**kwargs,
) -> DetailedResponse:
"""
Remove an account from its enterprise.
Remove an account from the enterprise its currently in. After an account is
removed, it will be canceled and cannot be reactivated.
:param str account_id: The ID of the ... | (self, account_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04011376574635506,
0.012105226516723633,
0.023892385885119438,
-0.07319264858961105,
0.011197802610695362,
-0.02151624485850334,
-0.035436321049928665,
0.023312384262681007,
-0.03762536495923996,
-0.00876553077250719,
0.020580755546689034,
-0.012732003815472126,
-0.021684633567929268,
-... |
719,461 | ibm_platform_services.enterprise_management_v1 | delete_account_group |
Delete an account group from the enterprise.
Delete an existing account group from the enterprise. You can't delete an account
group that has child account groups, the delete request will fail. This API
doesn't perform a recursive delete on the child account groups, it only deletes
... | def delete_account_group(
self,
account_group_id: str,
**kwargs,
) -> DetailedResponse:
"""
Delete an account group from the enterprise.
Delete an existing account group from the enterprise. You can't delete an account
group that has child account groups, the delete request will fail. This A... | (self, account_group_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.03423643112182617,
0.041597720235586166,
-0.05026238411664963,
-0.03232726827263832,
0.030252888798713684,
-0.05275898054242134,
-0.015980061143636703,
0.059330906718969345,
-0.016255419701337814,
0.0196607057005167,
0.056136731058359146,
-0.00752650760114193,
0.016494065523147583,
-0.0... |
719,465 | ibm_platform_services.enterprise_management_v1 | get_account |
Get account by ID.
Retrieve an account by the `account_id` parameter. All data related to the account
is returned only if the caller has access to retrieve the account.
:param str account_id: The ID of the target account.
:param dict headers: A `dict` containing the request he... | def get_account(
self,
account_id: str,
**kwargs,
) -> DetailedResponse:
"""
Get account by ID.
Retrieve an account by the `account_id` parameter. All data related to the account
is returned only if the caller has access to retrieve the account.
:param str account_id: The ID of the targe... | (self, account_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04213440418243408,
0.007649071980267763,
-0.003156393999233842,
-0.01670815236866474,
0.026246452704072,
-0.008160545490682125,
-0.01171321701258421,
-0.014865003526210785,
-0.022504858672618866,
-0.04773757979273796,
0.01468990370631218,
-0.018569733947515488,
0.00878260936588049,
-0.0... |
719,466 | ibm_platform_services.enterprise_management_v1 | get_account_group |
Get account group by ID.
Retrieve an account by the `account_group_id` parameter. All data related to the
account group is returned only if the caller has access to retrieve the account
group.
:param str account_group_id: The ID of the account group to retrieve.
:param... | def get_account_group(
self,
account_group_id: str,
**kwargs,
) -> DetailedResponse:
"""
Get account group by ID.
Retrieve an account by the `account_group_id` parameter. All data related to the
account group is returned only if the caller has access to retrieve the account
group.
:p... | (self, account_group_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04265608265995979,
0.0368565209209919,
-0.07711343467235565,
-0.022555964067578316,
0.03997354954481125,
-0.03525077551603317,
-0.0017639556899666786,
0.03194483742117882,
-0.0014876734931021929,
-0.008401812985539436,
0.03761216253042221,
-0.02657976560294628,
0.011891942471265793,
-0.... |
719,469 | ibm_platform_services.enterprise_management_v1 | get_enterprise |
Get enterprise by ID.
Retrieve an enterprise by the `enterprise_id` parameter. All data related to the
enterprise is returned only if the caller has access to retrieve the enterprise.
:param str enterprise_id: The ID of the enterprise to retrieve.
:param dict headers: A `dict`... | def get_enterprise(
self,
enterprise_id: str,
**kwargs,
) -> DetailedResponse:
"""
Get enterprise by ID.
Retrieve an enterprise by the `enterprise_id` parameter. All data related to the
enterprise is returned only if the caller has access to retrieve the enterprise.
:param str enterprise... | (self, enterprise_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.0008475779322907329,
-0.016158463433384895,
-0.0013615168863907456,
-0.014576767571270466,
0.040728677064180374,
-0.019986888393759727,
0.0027320205699652433,
-0.041447628289461136,
-0.04004567116498947,
0.0028735643718391657,
-0.008766730315983295,
-0.039614297449588776,
-0.01627529412508... |
719,471 | ibm_platform_services.enterprise_management_v1 | import_account_to_enterprise |
Import an account into an enterprise.
Import an existing stand-alone account into an enterprise. The existing account
can be any type: trial (`TRIAL`), Lite (`STANDARD`), Pay-As-You-Go (`PAYG`), or
Subscription (`SUBSCRIPTION`). In the case of a `SUBSCRIPTION` account, the
cred... | def import_account_to_enterprise(
self,
enterprise_id: str,
account_id: str,
*,
parent: Optional[str] = None,
billing_unit_id: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Import an account into an enterprise.
Import an existing stand-alone account into an enterpris... | (self, enterprise_id: str, account_id: str, *, parent: Optional[str] = None, billing_unit_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.05081223323941231,
-0.0026244819164276123,
-0.02288058213889599,
0.009645088575780392,
0.00650701904669404,
-0.01969539374113083,
-0.006964065134525299,
0.005168863106518984,
-0.07060186564922333,
-0.006337393540889025,
0.02566997893154621,
-0.07037569582462311,
-0.03330312296748161,
0.... |
719,472 | ibm_platform_services.enterprise_management_v1 | list_account_groups |
List account groups.
Retrieve all account groups based on the values that are passed in the query
parameters. If no query parameter is passed, all of the account groups in the
enterprise for which the calling identity has access are returned. <br/><br/>You
can use pagination pa... | def list_account_groups(
self,
*,
enterprise_id: Optional[str] = None,
parent_account_group_id: Optional[str] = None,
next_docid: Optional[str] = None,
parent: Optional[str] = None,
limit: Optional[int] = None,
include_deleted: Optional[bool] = None,
**kwargs,
) -> DetailedResponse:
... | (self, *, enterprise_id: Optional[str] = None, parent_account_group_id: Optional[str] = None, next_docid: Optional[str] = None, parent: Optional[str] = None, limit: Optional[int] = None, include_deleted: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04193351790308952,
-0.009716995060443878,
-0.07576796412467957,
-0.03483736887574196,
0.0020105759613215923,
0.012053994461894035,
-0.01656714640557766,
-0.013444839045405388,
0.0025191332679241896,
0.005175459198653698,
0.041592903435230255,
-0.04965412989258766,
0.04586951434612274,
-... |
719,473 | ibm_platform_services.enterprise_management_v1 | list_accounts |
List accounts.
Retrieve all accounts based on the values that are passed in the query parameters.
If no query parameter is passed, all of the accounts in the enterprise for which
the calling identity has access are returned. <br/><br/>You can use pagination
parameters to filter... | def list_accounts(
self,
*,
enterprise_id: Optional[str] = None,
account_group_id: Optional[str] = None,
next_docid: Optional[str] = None,
parent: Optional[str] = None,
limit: Optional[int] = None,
include_deleted: Optional[bool] = None,
**kwargs,
) -> DetailedResponse:
"""
L... | (self, *, enterprise_id: Optional[str] = None, account_group_id: Optional[str] = None, next_docid: Optional[str] = None, parent: Optional[str] = None, limit: Optional[int] = None, include_deleted: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.06455680727958679,
-0.025621332228183746,
-0.04773698002099991,
-0.01123497262597084,
0.005370410159230232,
0.04344811290502548,
-0.0276165883988142,
-0.06713012605905533,
-0.05075783655047417,
-0.027542000636458397,
0.04359728842973709,
-0.04628249257802963,
0.012903902679681778,
-0.01... |
719,474 | ibm_platform_services.enterprise_management_v1 | list_enterprises |
List enterprises.
Retrieve all enterprises for a given ID by passing the IDs on query parameters. If
no ID is passed, the enterprises for which the calling identity is the primary
contact are returned. You can use pagination parameters to filter the results.
<br/><br/>This meth... | def list_enterprises(
self,
*,
enterprise_account_id: Optional[str] = None,
account_group_id: Optional[str] = None,
account_id: Optional[str] = None,
next_docid: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> DetailedResponse:
"""
List enterprises.
Retrieve... | (self, *, enterprise_account_id: Optional[str] = None, account_group_id: Optional[str] = None, account_id: Optional[str] = None, next_docid: Optional[str] = None, limit: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.06820811331272125,
-0.043554581701755524,
-0.04882147163152695,
-0.03296476602554321,
0.01444659847766161,
0.015389783307909966,
-0.018172644078731537,
-0.07933956384658813,
-0.05423777922987938,
0.020675351843237877,
0.015436475165188313,
-0.03761531785130501,
-0.02181464433670044,
-0.... |
719,483 | ibm_platform_services.enterprise_management_v1 | update_account |
Move an account within the enterprise.
Move an account to a different parent within the same enterprise.
:param str account_id: The ID of the target account.
:param str parent: The CRN of the new parent within the enterprise.
:param dict headers: A `dict` containing the reques... | def update_account(
self,
account_id: str,
parent: str,
**kwargs,
) -> DetailedResponse:
"""
Move an account within the enterprise.
Move an account to a different parent within the same enterprise.
:param str account_id: The ID of the target account.
:param str parent: The CRN of the... | (self, account_id: str, parent: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.053967107087373734,
0.011548591777682304,
-0.050983257591724396,
-0.019266072660684586,
-0.018639832735061646,
-0.06258710473775864,
-0.03790590539574623,
0.025196928530931473,
0.01662297360599041,
-0.01987389288842678,
0.005253964569419622,
-0.07551711052656174,
0.023078765720129013,
0... |
719,484 | ibm_platform_services.enterprise_management_v1 | update_account_group |
Update an account group.
Update the name or IAM ID of the primary contact for an existing account group.
The new primary contact must already be a user in the enterprise account.
:param str account_group_id: The ID of the account group to retrieve.
:param str name: (optional) ... | def update_account_group(
self,
account_group_id: str,
*,
name: Optional[str] = None,
primary_contact_iam_id: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Update an account group.
Update the name or IAM ID of the primary contact for an existing account group.
The ne... | (self, account_group_id: str, *, name: Optional[str] = None, primary_contact_iam_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04338875785470009,
0.0327143557369709,
-0.06539031118154526,
-0.008356175385415554,
0.012959031388163567,
-0.07349210977554321,
-0.02155998907983303,
-0.0015970806125551462,
-0.0013031025882810354,
-0.005485990084707737,
0.02682039514183998,
-0.07226339727640152,
0.01069360040128231,
0.... |
719,485 | ibm_platform_services.enterprise_management_v1 | update_enterprise |
Update an enterprise.
Update the name, domain, or IAM ID of the primary contact for an existing
enterprise. The new primary contact must already be a user in the enterprise
account.
:param str enterprise_id: The ID of the enterprise to retrieve.
:param str name: (optio... | def update_enterprise(
self,
enterprise_id: str,
*,
name: Optional[str] = None,
domain: Optional[str] = None,
primary_contact_iam_id: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Update an enterprise.
Update the name, domain, or IAM ID of the primary contact for an ... | (self, enterprise_id: str, *, name: Optional[str] = None, domain: Optional[str] = None, primary_contact_iam_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.006997109856456518,
0.00025551405269652605,
-0.01853514462709427,
-0.017123650759458542,
0.009165424853563309,
-0.05649690330028534,
-0.02910277619957924,
-0.0384446382522583,
-0.01860014721751213,
0.00889612641185522,
-0.009936174377799034,
-0.08728975802659988,
-0.009105064906179905,
... |
719,486 | ibm_platform_services.enterprise_usage_reports_v1 | EnterpriseUsageReportsV1 | The Enterprise Usage Reports V1 service. | class EnterpriseUsageReportsV1(BaseService):
"""The Enterprise Usage Reports V1 service."""
DEFAULT_SERVICE_URL = 'https://enterprise.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'enterprise_usage_reports'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
)... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.0076714432798326015,
-0.10210691392421722,
-0.025526728481054306,
-0.009905751794576645,
-0.017001837491989136,
-0.011689362116158009,
-0.026197979226708412,
-0.016877176240086555,
-0.05254938825964928,
-0.044225871562957764,
0.003339475253596902,
-0.014556564390659332,
0.01229348778724670... |
719,487 | ibm_platform_services.enterprise_usage_reports_v1 | __init__ |
Construct a new client for the Enterprise Usage Reports service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Enterprise Usage Reports service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/pyt... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.026972472667694092,
-0.09464025497436523,
0.010728929191827774,
-0.011748131364583969,
-0.013067635707557201,
-0.031103884801268578,
-0.017408346757292747,
0.015934143215417862,
-0.03428889438509941,
-0.021749058738350868,
-0.0037082601338624954,
0.016534743830561638,
-0.04320691525936127... |
719,499 | ibm_platform_services.enterprise_usage_reports_v1 | get_resource_usage_report |
Get usage reports for enterprise entities.
Usage reports for entities in the IBM Cloud enterprise. These entities can be the
enterprise, an account group, or an account.
:param str enterprise_id: (optional) The ID of the enterprise for which the
reports are queried. Thi... | def get_resource_usage_report(
self,
*,
enterprise_id: str = None,
account_group_id: str = None,
account_id: str = None,
children: bool = None,
month: str = None,
billing_unit_id: str = None,
limit: int = None,
offset: str = None,
**kwargs,
) -> DetailedResponse:
"""
... | (self, *, enterprise_id: Optional[str] = None, account_group_id: Optional[str] = None, account_id: Optional[str] = None, children: Optional[bool] = None, month: Optional[str] = None, billing_unit_id: Optional[str] = None, limit: Optional[int] = None, offset: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detaile... | [
-0.031198523938655853,
-0.051265180110931396,
0.0060785855166614056,
0.00010627798474160954,
-0.03973051533102989,
0.004648195579648018,
0.023472128435969353,
-0.04690764099359512,
-0.08964082598686218,
-0.06873195618391037,
0.012660668231546879,
-0.0027371945325285196,
0.018437156453728676,... |
719,508 | ibm_platform_services.global_catalog_v1 | GlobalCatalogV1 | The Global Catalog V1 service. | class GlobalCatalogV1(BaseService):
"""The Global Catalog V1 service."""
DEFAULT_SERVICE_URL = 'https://globalcatalog.cloud.ibm.com/api/v1'
DEFAULT_SERVICE_NAME = 'global_catalog'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'GlobalCatalogV... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.005898905918002129,
-0.0711079016327858,
-0.05561825633049011,
-0.037239350378513336,
0.04370005801320076,
-0.023294659331440926,
-0.00473768450319767,
-0.00554778054356575,
0.04030919075012207,
-0.05822661519050598,
-0.039245784282684326,
0.001005723373964429,
-0.018047843128442764,
-0.... |
719,509 | ibm_platform_services.global_catalog_v1 | __init__ |
Construct a new client for the Global Catalog service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/master/README.md
about initializing the authent... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Global Catalog service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-co... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.028402678668498993,
-0.0718989297747612,
-0.0020342397037893534,
-0.013206874020397663,
0.012147350236773491,
-0.03699040040373802,
-0.0014684631023555994,
0.022547414526343346,
0.022863412275910378,
-0.021580832079052925,
-0.015446744859218597,
0.003585187718272209,
-0.05751170590519905,... |
719,515 | ibm_platform_services.global_catalog_v1 | create_catalog_entry |
Create a catalog entry.
The created catalog entry is restricted by default. You must have an administrator
or editor role in the scope of the provided token. This API will return an ETag
that can be used for standard ETag processing, except when depth query is used.
:param str... | def create_catalog_entry(
self,
name: str,
kind: str,
overview_ui: dict,
images: 'Image',
disabled: bool,
tags: List[str],
provider: 'Provider',
id: str,
*,
parent_id: str = None,
group: bool = None,
active: bool = None,
metadata: 'ObjectMetadataSet' = None,
a... | (self, name: str, kind: str, overview_ui: dict, images: ibm_platform_services.global_catalog_v1.Image, disabled: bool, tags: List[str], provider: ibm_platform_services.global_catalog_v1.Provider, id: str, *, parent_id: Optional[str] = None, group: Optional[bool] = None, active: Optional[bool] = None, metadata: Optional... | [
-0.04565014690160751,
-0.0005274154827930033,
-0.017786510288715363,
-0.03462592139840126,
0.015276698395609856,
-0.03352728486061096,
0.018525246530771255,
0.019396577030420303,
-0.00878433883190155,
-0.01844000816345215,
-0.005758358631283045,
0.04905970022082329,
-0.012804771773517132,
... |
719,516 | ibm_platform_services.global_catalog_v1 | delete_artifact |
Delete artifact.
This endpoint deletes an artifact. Only administrators and editors can delete
artifacts.
:param str object_id: The object's unique ID.
:param str artifact_id: The artifact's ID.
:param str account: (optional) This changes the scope of the request
... | def delete_artifact(self, object_id: str, artifact_id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Delete artifact.
This endpoint deletes an artifact. Only administrators and editors can delete
artifacts.
:param str object_id: The object's unique ID.
:param str artifact_id: T... | (self, object_id: str, artifact_id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.010988217778503895,
-0.012622087262570858,
-0.05476154386997223,
-0.019444836303591728,
0.006082122214138508,
-0.022012345492839813,
-0.003083703340962529,
0.07533752173185349,
-0.05530017986893654,
-0.0031802093144506216,
0.011419128626585007,
0.058855194598436356,
0.018349606543779373,
... |
719,517 | ibm_platform_services.global_catalog_v1 | delete_catalog_entry |
Delete a catalog entry.
Delete a catalog entry. This will archive the catalog entry for a minimum of two
weeks. While archived, it can be restored using the PUT restore API. After two
weeks, it will be deleted and cannot be restored. You must have administrator role
in the scop... | def delete_catalog_entry(self, id: str, *, account: str = None, force: bool = None, **kwargs) -> DetailedResponse:
"""
Delete a catalog entry.
Delete a catalog entry. This will archive the catalog entry for a minimum of two
weeks. While archived, it can be restored using the PUT restore API. After two
... | (self, id: str, *, account: Optional[str] = None, force: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.002331850817427039,
0.01291625015437603,
0.0017145961755886674,
-0.05497501417994499,
0.030959423631429672,
-0.032596442848443985,
-0.018780730664730072,
0.04529682174324989,
0.03667999058961868,
-0.02878272905945778,
-0.0157675389200449,
0.00385193875990808,
-0.005815010983496904,
-0.0... |
719,521 | ibm_platform_services.global_catalog_v1 | get_artifact |
Get artifact.
This endpoint returns the binary of an artifact.
:param str object_id: The object's unique ID.
:param str artifact_id: The artifact's ID.
:param str account: (optional) This changes the scope of the request
regardless of the authorization header. E... | def get_artifact(self, object_id: str, artifact_id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Get artifact.
This endpoint returns the binary of an artifact.
:param str object_id: The object's unique ID.
:param str artifact_id: The artifact's ID.
:param str account: (optiona... | (self, object_id: str, artifact_id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.02220589853823185,
-0.04355909302830696,
-0.08818406611680984,
0.0117691271007061,
0.014931246638298035,
-0.035316262394189835,
-0.0047032092697918415,
0.03961532562971115,
-0.060506634414196014,
-0.03085731714963913,
0.039188969880342484,
0.0807228833436966,
0.00848709512501955,
-0.0384... |
719,522 | ibm_platform_services.global_catalog_v1 | get_audit_logs |
Get the audit logs for an object.
This endpoint returns the audit logs for an object. Only administrators and
editors can get logs.
:param str id: The object's unique ID.
:param str account: (optional) This changes the scope of the request
regardless of the auth... | def get_audit_logs(
self,
id: str,
*,
account: str = None,
ascending: str = None,
startat: str = None,
offset: int = None,
limit: int = None,
**kwargs
) -> DetailedResponse:
"""
Get the audit logs for an object.
This endpoint returns the audit logs for an object. Only adm... | (self, id: str, *, account: Optional[str] = None, ascending: Optional[str] = None, startat: Optional[str] = None, offset: Optional[int] = None, limit: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.056120723485946655,
-0.007047418039292097,
0.01259852945804596,
-0.028984008356928825,
0.0033736166078597307,
-0.03301110491156578,
-0.03838672116398811,
-0.021724151447415352,
-0.06169954314827919,
0.00798030011355877,
-0.03162563592195511,
0.009753700345754623,
0.032475389540195465,
-... |
719,524 | ibm_platform_services.global_catalog_v1 | get_catalog_entry |
Get a specific catalog object.
This endpoint returns a specific catalog entry using the object's unique
identifier, for example `/*service_name*?complete=true`. This endpoint is ETag
enabled. This can be used by an unauthenticated user for publicly available
services.
... | def get_catalog_entry(
self,
id: str,
*,
account: str = None,
include: str = None,
languages: str = None,
complete: bool = None,
depth: int = None,
**kwargs
) -> DetailedResponse:
"""
Get a specific catalog object.
This endpoint returns a specific catalog entry using the ... | (self, id: str, *, account: Optional[str] = None, include: Optional[str] = None, languages: Optional[str] = None, complete: Optional[bool] = None, depth: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.020792771130800247,
-0.008498037233948708,
-0.012702527455985546,
-0.03174225613474846,
0.029211124405264854,
-0.012843145057559013,
0.019480332732200623,
-0.012768149375915527,
5.401357157097664e-7,
-0.044022928923368454,
-0.01542114932090044,
0.02351139299571514,
-0.012758774682879448,
... |
719,525 | ibm_platform_services.global_catalog_v1 | get_child_objects |
Get child catalog entries of a specific kind.
Fetch child catalog entries for a catalog entry with a specific id. This endpoint
is ETag enabled. This can be used by an unauthenticated user for publicly
available services.
:param str id: The parent catalog entry's ID.
:... | def get_child_objects(
self,
id: str,
kind: str,
*,
account: str = None,
include: str = None,
q: str = None,
sort_by: str = None,
descending: str = None,
languages: str = None,
complete: bool = None,
offset: int = None,
limit: int = None,
**kwargs
) -> DetailedRes... | (self, id: str, kind: str, *, account: Optional[str] = None, include: Optional[str] = None, q: Optional[str] = None, sort_by: Optional[str] = None, descending: Optional[str] = None, languages: Optional[str] = None, complete: Optional[bool] = None, offset: Optional[int] = None, limit: Optional[int] = None, **kwargs) -> ... | [
0.004333474673330784,
-0.02204611711204052,
-0.06885229051113129,
-0.0249831210821867,
-0.02799447998404503,
0.030429590493440628,
0.008206880651414394,
0.03448191285133362,
0.037697747349739075,
-0.04446400701999664,
-0.005553353577852249,
0.01914629153907299,
-0.00869483221322298,
-0.035... |
719,528 | ibm_platform_services.global_catalog_v1 | get_pricing |
Get the pricing for an object.
This endpoint returns the pricing for an object. Static pricing is defined in the
catalog. Dynamic pricing is stored in IBM Cloud Pricing Catalog. This can be used
by an unauthenticated user for publicly available services.
:param str id: The obj... | def get_pricing(self, id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Get the pricing for an object.
This endpoint returns the pricing for an object. Static pricing is defined in the
catalog. Dynamic pricing is stored in IBM Cloud Pricing Catalog. This can be used
by an unauthent... | (self, id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.013036794029176235,
-0.05930463224649429,
-0.01948215626180172,
-0.03628026694059372,
-0.006687290966510773,
0.0032158337999135256,
-0.0028552222065627575,
-0.03790530189871788,
-0.015821263194084167,
-0.00941241905093193,
0.032044220715761185,
-0.028246387839317322,
0.04312732070684433,
... |
719,529 | ibm_platform_services.global_catalog_v1 | get_visibility |
Get the visibility constraints for an object.
This endpoint returns the visibility rules for this object. Overall visibility is
determined by the parent objects and any further restrictions on this object. You
must have an administrator role in the scope of the provided token. This end... | def get_visibility(self, id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Get the visibility constraints for an object.
This endpoint returns the visibility rules for this object. Overall visibility is
determined by the parent objects and any further restrictions on this object. You
... | (self, id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.009148667566478252,
-0.034666791558265686,
-0.045462921261787415,
-0.03922359645366669,
0.03995969891548157,
0.012443589977920055,
0.009797136299312115,
-0.046970169991254807,
-0.024641813710331917,
0.013644133694469929,
-0.0032357715535908937,
-0.03184507414698601,
0.028199629858136177,
... |
719,530 | ibm_platform_services.global_catalog_v1 | list_artifacts |
Get artifacts.
This endpoint returns a list of artifacts for an object.
:param str object_id: The object's unique ID.
:param str account: (optional) This changes the scope of the request
regardless of the authorization header. Example scopes are `account` and
... | def list_artifacts(self, object_id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Get artifacts.
This endpoint returns a list of artifacts for an object.
:param str object_id: The object's unique ID.
:param str account: (optional) This changes the scope of the request
re... | (self, object_id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.006154278293251991,
-0.06031370908021927,
-0.08514457195997238,
-0.03097623586654663,
-0.0019593939650803804,
0.011079481802880764,
-0.01588890329003334,
-0.013733570463955402,
-0.037014733999967575,
0.0015485892072319984,
0.00021069051581434906,
0.02844683639705181,
0.020840825513005257,... |
719,531 | ibm_platform_services.global_catalog_v1 | list_catalog_entries |
Returns parent catalog entries.
Includes key information, such as ID, name, kind, CRN, tags, and provider. This
endpoint is ETag enabled.
:param str account: (optional) This changes the scope of the request
regardless of the authorization header. Example scopes are `acc... | def list_catalog_entries(
self,
*,
account: str = None,
include: str = None,
q: str = None,
sort_by: str = None,
descending: str = None,
languages: str = None,
catalog: bool = None,
complete: bool = None,
offset: int = None,
limit: int = None,
**kwargs
) -> DetailedRe... | (self, *, account: Optional[str] = None, include: Optional[str] = None, q: Optional[str] = None, sort_by: Optional[str] = None, descending: Optional[str] = None, languages: Optional[str] = None, catalog: Optional[bool] = None, complete: Optional[bool] = None, offset: Optional[int] = None, limit: Optional[int] = None, *... | [
-0.01701974682509899,
-0.03394608199596405,
-0.04282026365399361,
-0.04412803798913956,
0.01985948532819748,
0.011592484079301357,
-0.0032904534600675106,
-0.0385606586933136,
0.02552028000354767,
-0.047901902347803116,
-0.021933242678642273,
0.004607568960636854,
-0.010219321586191654,
-0... |
719,533 | ibm_platform_services.global_catalog_v1 | restore_catalog_entry |
Restore archived catalog entry.
Restore an archived catalog entry. You must have an administrator role in the
scope of the provided token.
:param str id: The catalog entry's unique ID.
:param str account: (optional) This changes the scope of the request
regardle... | def restore_catalog_entry(self, id: str, *, account: str = None, **kwargs) -> DetailedResponse:
"""
Restore archived catalog entry.
Restore an archived catalog entry. You must have an administrator role in the
scope of the provided token.
:param str id: The catalog entry's unique ID.
:param str ... | (self, id: str, *, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.011428979225456715,
0.022332489490509033,
0.019424885511398315,
-0.011639167554676533,
0.009274551644921303,
-0.04403441399335861,
-0.006743535865098238,
0.03317469358444214,
0.033314820379018784,
-0.03786889463663101,
-0.045365605503320694,
0.018268851563334465,
-0.036082297563552856,
... |
719,541 | ibm_platform_services.global_catalog_v1 | update_catalog_entry |
Update a catalog entry.
Update a catalog entry. The visibility of the catalog entry cannot be modified
with this endpoint. You must be an administrator or editor in the scope of the
provided token. This endpoint is ETag enabled.
:param str id: The object's unique ID.
:... | def update_catalog_entry(
self,
id: str,
name: str,
kind: str,
overview_ui: dict,
images: 'Image',
disabled: bool,
tags: List[str],
provider: 'Provider',
*,
parent_id: str = None,
group: bool = None,
active: bool = None,
metadata: 'ObjectMetadataSet' = None,
a... | (self, id: str, name: str, kind: str, overview_ui: dict, images: ibm_platform_services.global_catalog_v1.Image, disabled: bool, tags: List[str], provider: ibm_platform_services.global_catalog_v1.Provider, *, parent_id: Optional[str] = None, group: Optional[bool] = None, active: Optional[bool] = None, metadata: Optional... | [
-0.023736130446195602,
-0.016711389645934105,
-0.05327656492590904,
-0.02986716479063034,
0.01450114231556654,
-0.06438545882701874,
0.014578021131455898,
0.039169423282146454,
0.012108310125768185,
-0.007889620959758759,
-0.04074542224407196,
-0.014020654372870922,
0.006087789312005043,
0... |
719,542 | ibm_platform_services.global_catalog_v1 | update_visibility |
Update visibility.
Update an Object's Visibility. You must have an administrator role in the scope of
the provided token. This endpoint is ETag enabled.
:param str id: The object's unique ID.
:param bool extendable: (optional) Allows the visibility to be extenable.
:pa... | def update_visibility(
self,
id: str,
*,
extendable: bool = None,
include: 'VisibilityDetail' = None,
exclude: 'VisibilityDetail' = None,
account: str = None,
**kwargs
) -> DetailedResponse:
"""
Update visibility.
Update an Object's Visibility. You must have an administrator ... | (self, id: str, *, extendable: Optional[bool] = None, include: Optional[ibm_platform_services.global_catalog_v1.VisibilityDetail] = None, exclude: Optional[ibm_platform_services.global_catalog_v1.VisibilityDetail] = None, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.017072055488824844,
-0.0365842841565609,
-0.06344456225633621,
-0.02341100573539734,
0.04895028844475746,
-0.02676854096353054,
0.00004633380740415305,
0.007013211026787758,
-0.07588395476341248,
0.02322753518819809,
-0.03374047204852104,
-0.061756622046232224,
0.020915789529681206,
-0.0... |
719,543 | ibm_platform_services.global_catalog_v1 | upload_artifact |
Upload artifact.
This endpoint uploads the binary for an artifact. Only administrators and editors
can upload artifacts.
:param str object_id: The object's unique ID.
:param str artifact_id: The artifact's ID.
:param BinaryIO artifact: (optional)
:param str con... | def upload_artifact(
self,
object_id: str,
artifact_id: str,
*,
artifact: BinaryIO = None,
content_type: str = None,
account: str = None,
**kwargs
) -> DetailedResponse:
"""
Upload artifact.
This endpoint uploads the binary for an artifact. Only administrators and editors
... | (self, object_id: str, artifact_id: str, *, artifact: Optional[BinaryIO] = None, content_type: Optional[str] = None, account: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.007725889328867197,
-0.023159489035606384,
-0.07511382550001144,
0.03393937647342682,
0.004101538565009832,
-0.04700976610183716,
-0.00435603829100728,
0.07984025031328201,
-0.08333053439855576,
-0.03337584063410759,
0.032957736402750015,
0.05424483120441437,
0.010443584993481636,
-0.03... |
719,544 | ibm_platform_services.global_search_v2 | GlobalSearchV2 | The global_search V2 service. | class GlobalSearchV2(BaseService):
"""The global_search V2 service."""
DEFAULT_SERVICE_URL = 'https://api.global-search-tagging.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'global_search'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'GlobalSearch... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.029584279283881187,
-0.07526559382677078,
-0.05825214460492134,
-0.017451737076044083,
0.039883989840745926,
-0.0005845883279107511,
-0.04884892329573631,
-0.061320140957832336,
0.03388744592666626,
-0.08423052728176117,
-0.01578824408352375,
-0.003150177886709571,
-0.01318841241300106,
... |
719,545 | ibm_platform_services.global_search_v2 | __init__ |
Construct a new client for the global_search service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the authentica... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the global_search service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-cor... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.0014766375534236431,
-0.09314963966608047,
-0.020951537415385246,
-0.004045429639518261,
-0.004281691741198301,
-0.01751905120909214,
-0.029777929186820984,
0.006231967825442553,
0.03364727646112442,
-0.014933542348444462,
-0.003423570189625025,
-0.007832308299839497,
-0.04158211499452591... |
719,558 | ibm_platform_services.global_search_v2 | search |
Find instances of resources (v3).
Find IAM-enabled resources or storage and network resources that run on classic
infrastructure in a specific account ID. You can apply query strings if necessary.
To filter results, you can insert a string by using the Lucene syntax and the
que... | def search(
self,
*,
query: Optional[str] = None,
fields: Optional[List[str]] = None,
search_cursor: Optional[str] = None,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
account_id: Optional[str] = None,
limit: Optional[int] = None,
timeout: Optional[... | (self, *, query: Optional[str] = None, fields: Optional[List[str]] = None, search_cursor: Optional[str] = None, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, account_id: Optional[str] = None, limit: Optional[int] = None, timeout: Optional[int] = None, sort: Optional[List[str]] = None, is_d... | [
0.008732345886528492,
-0.05343501642346382,
-0.05505426228046417,
-0.03273183852434158,
0.02265012450516224,
0.018062269315123558,
-0.02299710549414158,
-0.07656706124544144,
0.010698569938540459,
-0.07267316430807114,
-0.0006692630122415721,
0.042100317776203156,
0.0026457272469997406,
-0... |
719,566 | ibm_platform_services.global_tagging_v1 | GlobalTaggingV1 | The global_tagging V1 service. | class GlobalTaggingV1(BaseService):
"""The global_tagging V1 service."""
DEFAULT_SERVICE_URL = 'https://tags.global-search-tagging.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'global_tagging'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'GlobalTa... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.027664879336953163,
-0.0754680186510086,
-0.0825708881020546,
-0.05989012494683266,
0.022882547229528427,
0.013418777845799923,
-0.05783190578222275,
-0.024194158613681793,
0.03385971486568451,
-0.0671544298529625,
-0.026696305721998215,
0.007183586712926626,
-0.01978513039648533,
-0.067... |
719,567 | ibm_platform_services.global_tagging_v1 | __init__ |
Construct a new client for the global_tagging service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the authentic... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the global_tagging service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-co... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.003635094501078129,
-0.08680053800344467,
-0.04579298943281174,
-0.019730741158127785,
-0.02083507366478443,
-0.029964223504066467,
-0.026135869324207306,
0.024884292855858803,
0.0019900992047041655,
-0.019289007410407066,
-0.008705821819603443,
0.0011077835224568844,
-0.07855485379695892... |
719,572 | ibm_platform_services.global_tagging_v1 | attach_tag |
Attach tags.
Attaches one or more tags to one or more resources. Each resource can have no more
than 1000 tags per each 'user' and 'service' type, and no more than 250 'access'
tags (which is the account limit).
:param List[Resource] resources: List of resources on which the t... | def attach_tag(
self,
resources: List['Resource'],
*,
tag_name: Optional[str] = None,
tag_names: Optional[List[str]] = None,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
replace: Opti... | (self, resources: List[ibm_platform_services.global_tagging_v1.Resource], *, tag_name: Optional[str] = None, tag_names: Optional[List[str]] = None, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, replace: Optional[bool] = None... | [
0.0015949669759720564,
-0.016255421563982964,
-0.06271049380302429,
-0.0424104742705822,
0.005214639473706484,
0.01795993000268936,
-0.028697367757558823,
-0.038019198924303055,
-0.009321830235421658,
-0.029159607365727425,
-0.0008354015881195664,
0.010592988692224026,
-0.019481468945741653,... |
719,574 | ibm_platform_services.global_tagging_v1 | create_tag |
Create an access management tag.
Create an access management tag. To create an `access` tag, you must have the
access listed in the [Granting users access to tag
resources](https://cloud.ibm.com/docs/account?topic=account-access) documentation.
`service` and `user` tags cannot ... | def create_tag(
self,
tag_names: List[str],
*,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Create an access management tag.
Create an access ... | (self, tag_names: List[str], *, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.03353118896484375,
-0.004706089850515127,
-0.031510546803474426,
-0.09683822095394135,
0.0014142097206786275,
0.014449482783675194,
-0.07144678384065628,
0.021693287417292595,
-0.025219876319169998,
-0.04094655439257622,
0.017366066575050354,
0.09485571086406708,
0.031205546110868454,
-... |
719,575 | ibm_platform_services.global_tagging_v1 | delete_tag |
Delete an unused tag.
Delete an existing tag. A tag can be deleted only if it is not attached to any
resource.
:param str tag_name: The name of tag to be deleted.
:param str x_request_id: (optional) An alphanumeric string that is used to
trace the request. The v... | def delete_tag(
self,
tag_name: str,
*,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
providers: Optional[List[str]] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Delete an unused t... | (self, tag_name: str, *, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, providers: Optional[List[str]] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.02956835925579071,
-0.018941029906272888,
-0.06409037858247757,
-0.09630837291479111,
-0.0001359766611130908,
0.0033528408966958523,
-0.05199423432350159,
0.03121957927942276,
0.007425690535455942,
-0.02855074778199196,
0.0124513516202569,
0.033562008291482925,
0.0013224161230027676,
-0.... |
719,576 | ibm_platform_services.global_tagging_v1 | delete_tag_all |
Delete all unused tags.
Delete the tags that are not attached to any resource.
:param str x_request_id: (optional) An alphanumeric string that is used to
trace the request. The value may include ASCII alphanumerics and any of
following segment separators: space ... | def delete_tag_all(
self,
*,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
providers: Optional[str] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Delete all unused tags.
Delete the ... | (self, *, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, providers: Optional[str] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04470202699303627,
-0.03590108081698418,
-0.059929363429546356,
-0.09008250385522842,
-0.028438178822398186,
0.00684570474550128,
-0.05989167094230652,
-0.016065970063209534,
0.0018221447244286537,
-0.021182579919695854,
0.006610133685171604,
0.019373392686247826,
-0.01123204454779625,
... |
719,577 | ibm_platform_services.global_tagging_v1 | detach_tag |
Detach tags.
Detaches one or more tags from one or more resources.
:param List[Resource] resources: List of resources on which the tag or tags
are detached.
:param str tag_name: (optional) The name of the tag to detach.
:param List[str] tag_names: (optional) An ... | def detach_tag(
self,
resources: List['Resource'],
*,
tag_name: Optional[str] = None,
tag_names: Optional[List[str]] = None,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
**kwargs,
) -... | (self, resources: List[ibm_platform_services.global_tagging_v1.Resource], *, tag_name: Optional[str] = None, tag_names: Optional[List[str]] = None, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_cor... | [
0.021384377032518387,
-0.008936965838074684,
-0.07051166892051697,
-0.0952267125248909,
-0.026929175481200218,
0.003247870597988367,
-0.01625591143965721,
-0.020608482882380486,
-0.013757913373410702,
0.013142875395715237,
-0.005407597869634628,
0.008918042294681072,
-0.032341502606868744,
... |
719,584 | ibm_platform_services.global_tagging_v1 | list_tags |
Get all tags.
Lists all tags that are in a billing account. Use the `attached_to` parameter to
return the list of tags that are attached to the specified resource.
:param str x_request_id: (optional) An alphanumeric string that is used to
trace the request. The value m... | def list_tags(
self,
*,
x_request_id: Optional[str] = None,
x_correlation_id: Optional[str] = None,
account_id: Optional[str] = None,
tag_type: Optional[str] = None,
full_data: Optional[bool] = None,
providers: Optional[List[str]] = None,
attached_to: Optional[str] = None,
offset... | (self, *, x_request_id: Optional[str] = None, x_correlation_id: Optional[str] = None, account_id: Optional[str] = None, tag_type: Optional[str] = None, full_data: Optional[bool] = None, providers: Optional[List[str]] = None, attached_to: Optional[str] = None, offset: Optional[int] = None, limit: Optional[int] = None, t... | [
0.0000478749570902437,
-0.058489348739385605,
-0.06520186364650726,
-0.08334072679281235,
-0.007853260263800621,
0.048081185668706894,
-0.03848380595445633,
-0.05679236724972725,
0.006886922754347324,
-0.05988464504480362,
-0.02726486138999462,
-0.008843167684972286,
-0.02468167617917061,
... |
719,610 | ibm_platform_services.iam_access_groups_v2 | IamAccessGroupsV2 | The iam-access-groups V2 service. | class IamAccessGroupsV2(BaseService):
"""The iam-access-groups V2 service."""
DEFAULT_SERVICE_URL = 'https://iam.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'iam_access_groups'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'IamAccessGroupsV2':
... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
-0.007504675071686506,
-0.01745445467531681,
-0.05533771589398384,
-0.023223211988806725,
0.026906747370958328,
-0.04970656335353851,
-0.041471533477306366,
0.02817693166434765,
0.015528008341789246,
0.009695743210613728,
0.010299080982804298,
0.005091323982924223,
0.05762404948472977,
-0.... |
719,611 | ibm_platform_services.iam_access_groups_v2 | __init__ |
Construct a new client for the iam-access-groups service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-core/blob/main/README.md
about initializing the authen... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the iam-access-groups service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.01753804460167885,
-0.06058932840824127,
-0.012368937022984028,
-0.01565501280128956,
-0.011390498839318752,
-0.03562992438673973,
-0.01231355406343937,
0.0232425257563591,
-0.008275188505649567,
0.011030507273972034,
0.00029653141973540187,
0.018258027732372284,
-0.022522542625665665,
... |
719,616 | ibm_platform_services.iam_access_groups_v2 | add_access_group_rule |
Create rule for an access group.
Rules can be used to dynamically add users to an access group. If a user's SAML
assertions match the rule's conditions during login, the user will be dynamically
added to the group. The duration of the user's access to the group is determined
by... | def add_access_group_rule(
self,
access_group_id: str,
expiration: int,
realm_name: str,
conditions: List['RuleConditions'],
*,
name: str = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create rule for an access group.
Rules can be used to dynamic... | (self, access_group_id: str, expiration: int, realm_name: str, conditions: List[ibm_platform_services.iam_access_groups_v2.RuleConditions], *, name: Optional[str] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.06953313946723938,
0.0815938264131546,
-0.03918752819299698,
-0.012303060851991177,
0.016336215659976006,
-0.00485481321811676,
-0.08252455294132233,
0.0089340191334486,
-0.014891648665070534,
-0.008298991248011589,
0.026680869981646538,
0.03660863637924194,
0.06425901502370834,
0.00907... |
719,617 | ibm_platform_services.iam_access_groups_v2 | add_member_to_multiple_access_groups |
Add member to multiple access groups.
This API will add a member to multiple access groups in an account. The limit of
how many groups that can be in the request is 50. The response is a list of
results that show if adding the member to each group was successful or not.
:param... | def add_member_to_multiple_access_groups(
self,
account_id: str,
iam_id: str,
*,
type: str = None,
groups: List[str] = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Add member to multiple access groups.
This API will add a member to multiple access gr... | (self, account_id: str, iam_id: str, *, type: Optional[str] = None, groups: Optional[List[str]] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.051867514848709106,
0.04118550568819046,
-0.029423726722598076,
-0.01529031153768301,
-0.031737521290779114,
-0.039257343858480453,
-0.02080485038459301,
-0.016514694318175316,
-0.018404290080070496,
0.0349382646381855,
0.04326791688799858,
0.012128128670156002,
0.04646866396069527,
0.0... |
719,618 | ibm_platform_services.iam_access_groups_v2 | add_members_to_access_group |
Add members to an access group.
Use this API to add users (`IBMid-...`), service IDs (`iam-ServiceId-...`) or
trusted profiles (`iam-Profile-...`) to an access group. Any member added gains
access to resources defined in the group's policies. To revoke a given members's
access,... | def add_members_to_access_group(
self,
access_group_id: str,
*,
members: List['AddGroupMembersRequestMembersItem'] = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Add members to an access group.
Use this API to add users (`IBMid-...`), service IDs (`iam-Servi... | (self, access_group_id: str, *, members: Optional[List[ibm_platform_services.iam_access_groups_v2.AddGroupMembersRequestMembersItem]] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.059177618473768234,
0.018804466351866722,
-0.006501751486212015,
-0.0027763841208070517,
-0.022697731852531433,
-0.04138540104031563,
-0.02232787013053894,
0.08316012471914291,
-0.007659997791051865,
0.00205369689501822,
0.014278546907007694,
0.026999788358807564,
0.07689197361469269,
0... |
719,619 | ibm_platform_services.iam_access_groups_v2 | commit_template |
Commit a template.
Commit a template version. You must do this before you can assign a template
version to child accounts. After you commit the template version, you can't make
any further changes.
:param str template_id: ID of the template to commit.
:param str versio... | def commit_template(
self,
template_id: str,
version_num: str,
if_match: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Commit a template.
Commit a template version. You must do this before you can assign a template
version to child accounts. After y... | (self, template_id: str, version_num: str, if_match: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.060639288276433945,
-0.06291097402572632,
-0.05789128318428993,
-0.005954008549451828,
-0.021306190639734268,
-0.051369354128837585,
-0.05250519514083862,
0.04363830387592316,
-0.05496007949113846,
-0.04217270016670227,
0.04235590249300003,
-0.05327463522553444,
-0.02354123443365097,
-0.... |
719,621 | ibm_platform_services.iam_access_groups_v2 | create_access_group |
Create an access group.
Create a new access group to assign multiple users and service ids to multiple
policies. The group will be created in the account specified by the `account_id`
parameter. The group name is a required field, but a description is optional.
Because the grou... | def create_access_group(
self,
account_id: str,
name: str,
*,
description: str = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create an access group.
Create a new access group to assign multiple users and service ids to multiple
policies. The group w... | (self, account_id: str, name: str, *, description: Optional[str] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.09400790184736252,
0.03664616867899895,
-0.03266832232475281,
-0.04577408358454704,
0.007009276654571295,
-0.056227948516607285,
-0.05111631378531456,
0.027825724333524704,
-0.00766264321282506,
-0.005601656157523394,
0.05130848288536072,
0.07121694087982178,
0.0524999164044857,
-0.0034... |
719,622 | ibm_platform_services.iam_access_groups_v2 | create_assignment |
Create assignment.
Assign a template version to accounts that have enabled enterprise-managed IAM.
You can specify individual accounts, or an entire account group to assign the
template to all current and future child accounts of that account group.
:param str template_id: The... | def create_assignment(
self,
template_id: str,
template_version: str,
target_type: str,
target: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create assignment.
Assign a template version to accounts that have enabled enterprise-managed IAM.
You ... | (self, template_id: str, template_version: str, target_type: str, target: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.010709412395954132,
0.01612919196486473,
-0.03636737912893295,
-0.03900754451751709,
0.004520357120782137,
-0.004462255164980888,
-0.06767753511667252,
0.000033172771509271115,
-0.05834398418664932,
-0.017737463116645813,
0.04157334193587303,
-0.010709412395954132,
0.030640818178653717,
... |
719,623 | ibm_platform_services.iam_access_groups_v2 | create_template |
Create template.
Create an access group template. Make sure that the template is generic enough to
apply to multiple different child accounts. Before you can assign an access group
template to child accounts, you must commit it so that no further changes can be
made to the vers... | def create_template(
self,
name: str,
account_id: str,
*,
description: str = None,
group: 'AccessGroupRequest' = None,
policy_template_references: List['PolicyTemplates'] = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create template.
Create an a... | (self, name: str, account_id: str, *, description: Optional[str] = None, group: Optional[ibm_platform_services.iam_access_groups_v2.AccessGroupRequest] = None, policy_template_references: Optional[List[ibm_platform_services.iam_access_groups_v2.PolicyTemplates]] = None, transaction_id: Optional[str] = None, **kwargs) -... | [
0.001067919423803687,
0.01691065914928913,
-0.007413695566356182,
-0.003259385470300913,
-0.022417137399315834,
-0.014260116964578629,
-0.09522393345832825,
0.03751838579773903,
-0.018592923879623413,
-0.03937670215964317,
0.06779912859201431,
-0.005887921899557114,
-0.06142217665910721,
-... |
719,624 | ibm_platform_services.iam_access_groups_v2 | create_template_version |
Create template version.
Create a new version of an access group template.
:param str template_id: ID of the template that you want to create a new
version of.
:param str name: (optional) This is an optional field. If the field is
included it will change ... | def create_template_version(
self,
template_id: str,
*,
name: str = None,
description: str = None,
group: 'AccessGroupRequest' = None,
policy_template_references: List['PolicyTemplates'] = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create template ... | (self, template_id: str, *, name: Optional[str] = None, description: Optional[str] = None, group: Optional[ibm_platform_services.iam_access_groups_v2.AccessGroupRequest] = None, policy_template_references: Optional[List[ibm_platform_services.iam_access_groups_v2.PolicyTemplates]] = None, transaction_id: Optional[str] =... | [
0.0419638566672802,
-0.027301324531435966,
-0.013975223526358604,
0.009106805548071861,
-0.04165838658809662,
-0.037019070237874985,
-0.07568003982305527,
0.054144445806741714,
-0.032284293323755264,
-0.015359382145106792,
0.027835896238684654,
-0.008906341157853603,
-0.061170242726802826,
... |
719,625 | ibm_platform_services.iam_access_groups_v2 | delete_access_group |
Delete an access group.
This API is used for deleting an access group. If the access group has no members
or rules associated with it, the group and its policies will be deleted. However,
if rules or members do exist, set the `force` parameter to true to delete the
group as wel... | def delete_access_group(
self,
access_group_id: str,
*,
transaction_id: str = None,
force: bool = None,
**kwargs,
) -> DetailedResponse:
"""
Delete an access group.
This API is used for deleting an access group. If the access group has no members
or rules associated with it, the ... | (self, access_group_id: str, *, transaction_id: Optional[str] = None, force: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.017995895817875862,
0.06080347299575806,
0.01021438930183649,
-0.025313112884759903,
0.017150888219475746,
-0.05720057711005211,
-0.0721321552991867,
0.08892089873552322,
0.030698882415890694,
-0.012090122327208519,
0.026093121618032455,
0.03552750125527382,
0.03342891111969948,
-0.0221... |
719,626 | ibm_platform_services.iam_access_groups_v2 | delete_assignment |
Delete assignment.
Delete an access group template assignment.
:param str assignment_id: assignment id path parameter.
:param str transaction_id: (optional) An optional transaction id for the
request.
:param dict headers: A `dict` containing the request headers
... | def delete_assignment(
self,
assignment_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Delete assignment.
Delete an access group template assignment.
:param str assignment_id: assignment id path parameter.
:param str transaction_id: (optional) An opt... | (self, assignment_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.0031788996420800686,
0.045080963522195816,
0.002708936808630824,
-0.046074092388153076,
0.0006628249539062381,
-0.009496795944869518,
-0.09413444250822067,
0.05100426822900772,
-0.030414575710892677,
-0.043272048234939575,
0.014559980481863022,
-0.01138551440089941,
0.01649303548038006,
... |
719,627 | ibm_platform_services.iam_access_groups_v2 | delete_template |
Delete template.
Endpoint to delete a template. All access assigned by that template is deleted
from all of the accounts where the template was assigned.
:param str template_id: template id parameter.
:param str transaction_id: (optional) An optional transaction id for the
... | def delete_template(
self,
template_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Delete template.
Endpoint to delete a template. All access assigned by that template is deleted
from all of the accounts where the template was assigned.
:param str te... | (self, template_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.057204507291316986,
-0.008711700327694416,
0.04835806414484978,
-0.05616375058889389,
-0.032319243997335434,
-0.03187320753931999,
-0.07880023121833801,
0.05419374257326126,
-0.01763712614774704,
-0.015202497132122517,
0.020294776186347008,
-0.035348594188690186,
-0.023528559133410454,
-... |
719,628 | ibm_platform_services.iam_access_groups_v2 | delete_template_version |
Delete template version.
Delete a template version. You must remove all assignments for a template version
before you can delete it.
:param str template_id: ID of the template to delete.
:param str version_num: version number in path.
:param str transaction_id: (option... | def delete_template_version(
self,
template_id: str,
version_num: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Delete template version.
Delete a template version. You must remove all assignments for a template version
before you can delete it.
:par... | (self, template_id: str, version_num: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.07899272441864014,
-0.03459616005420685,
-0.0017627370543777943,
-0.029014352709054947,
-0.02457469515502453,
-0.037801556289196014,
-0.07737160474061966,
0.06771857291460037,
-0.043475471436977386,
0.012968954630196095,
0.014801925048232079,
-0.028093261644244194,
-0.015363790094852448,
... |
719,632 | ibm_platform_services.iam_access_groups_v2 | get_access_group |
Get an access group.
Retrieve an access group by its `access_group_id`. Only the groups data is
returned (group name, description, account_id, ...), not membership or rule
information. A revision number is returned in the `ETag` header, which is needed
when updating the access ... | def get_access_group(
self,
access_group_id: str,
*,
transaction_id: str = None,
show_federated: bool = None,
**kwargs,
) -> DetailedResponse:
"""
Get an access group.
Retrieve an access group by its `access_group_id`. Only the groups data is
returned (group name, description, ac... | (self, access_group_id: str, *, transaction_id: Optional[str] = None, show_federated: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.029988911002874374,
0.029004426673054695,
-0.017361003905534744,
0.020219795405864716,
0.039417244493961334,
-0.03385112062096596,
-0.02983745187520981,
0.05956130847334862,
0.011018653400242329,
-0.018222428858280182,
0.0007827361696399748,
0.01752193085849285,
0.03288556635379791,
0.0... |
719,633 | ibm_platform_services.iam_access_groups_v2 | get_access_group_rule |
Get an access group rule.
Retrieve a rule from an access group. A revision number is returned in the `ETag`
header, which is needed when updating the rule.
:param str access_group_id: The access group identifier.
:param str rule_id: The rule to get.
:param str transact... | def get_access_group_rule(
self,
access_group_id: str,
rule_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get an access group rule.
Retrieve a rule from an access group. A revision number is returned in the `ETag`
header, which is needed when updati... | (self, access_group_id: str, rule_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.045600082725286484,
0.09333651512861252,
-0.02661232464015484,
0.010110842064023018,
0.014144129119813442,
-0.013619248755276203,
-0.0573868565261364,
0.020792605355381966,
-0.00469629280269146,
-0.04898877814412117,
0.00693393824622035,
0.021179359406232834,
0.05267214775085449,
0.0035... |
719,634 | ibm_platform_services.iam_access_groups_v2 | get_account_settings |
Get account settings.
Retrieve the access groups settings for a specific account.
:param str account_id: Account ID of the API keys(s) to query. If a service
IAM ID is specified in iam_id then account_id must match the account of the
IAM ID. If a user IAM ID is s... | def get_account_settings(
self,
account_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get account settings.
Retrieve the access groups settings for a specific account.
:param str account_id: Account ID of the API keys(s) to query. If a service
... | (self, account_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04220772534608841,
0.005711995996534824,
-0.0032217788975685835,
-0.017324935644865036,
0.004360302351415157,
0.004791487939655781,
-0.07085006684064865,
-0.037866804748773575,
-0.022576676681637764,
0.00010552537423791364,
0.018972160294651985,
-0.02085193432867527,
0.019757013767957687,... |
719,635 | ibm_platform_services.iam_access_groups_v2 | get_assignment |
Get assignment.
Get a specific template assignment.
:param str assignment_id: Assignment ID.
:param str transaction_id: (optional) An optional transaction id for the
request.
:param bool verbose: (optional) Returns resources access group template
... | def get_assignment(
self,
assignment_id: str,
*,
transaction_id: str = None,
verbose: bool = None,
**kwargs,
) -> DetailedResponse:
"""
Get assignment.
Get a specific template assignment.
:param str assignment_id: Assignment ID.
:param str transaction_id: (optional) An option... | (self, assignment_id: str, *, transaction_id: Optional[str] = None, verbose: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.016646914184093475,
0.03342104330658913,
-0.020336132496595383,
-0.021844532340765,
0.010631490498781204,
0.029004886746406555,
-0.049577273428440094,
-0.02753283455967903,
-0.010667837224900723,
-0.05673762783408165,
0.018082620576024055,
-0.03563820943236351,
-0.013511988334357738,
0.0... |
719,639 | ibm_platform_services.iam_access_groups_v2 | get_latest_template_version |
Get latest template version.
Get the latest version of a template.
:param str template_id: ID of the template to get a specific version of.
:param bool verbose: (optional) If `verbose=true`, IAM resource details are
returned. If performance is a concern, leave the `verb... | def get_latest_template_version(
self,
template_id: str,
*,
verbose: bool = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get latest template version.
Get the latest version of a template.
:param str template_id: ID of the template to get a specific versi... | (self, template_id: str, *, verbose: Optional[bool] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.08294453471899033,
-0.055783387273550034,
-0.01215695682913065,
-0.01655893586575985,
-0.03669565171003342,
-0.04042328521609306,
-0.03633974865078926,
-0.004076514393091202,
-0.024370109662413597,
-0.02478220872581005,
0.019818274304270744,
-0.02169145829975605,
-0.06410031765699387,
-0... |
719,640 | ibm_platform_services.iam_access_groups_v2 | get_template_version |
Get template version.
Get a specific version of a template.
:param str template_id: ID of the template to get a specific version of.
:param str version_num: Version number.
:param bool verbose: (optional) If `verbose=true`, IAM resource details are
returned. If ... | def get_template_version(
self,
template_id: str,
version_num: str,
*,
verbose: bool = None,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get template version.
Get a specific version of a template.
:param str template_id: ID of the template to get a specif... | (self, template_id: str, version_num: str, *, verbose: Optional[bool] = None, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.08480039238929749,
-0.06011636182665825,
-0.006986395921558142,
0.008561577647924423,
-0.035117294639348984,
-0.03278231993317604,
-0.03884213790297508,
0.012277154251933098,
-0.0356547087430954,
-0.017503052949905396,
0.03148511052131653,
-0.029872864484786987,
-0.04388272017240524,
-0.... |
719,641 | ibm_platform_services.iam_access_groups_v2 | is_member_of_access_group |
Check membership in an access group.
This HEAD operation determines if a given `iam_id` is present in a group either
explicitly or via dynamic rules. No response body is returned with this request.
If the membership exists, a `204 - No Content` status code is returned. If the
m... | def is_member_of_access_group(
self,
access_group_id: str,
iam_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Check membership in an access group.
This HEAD operation determines if a given `iam_id` is present in a group either
explicitly or via dynam... | (self, access_group_id: str, iam_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0005474823410622776,
0.011255715042352676,
-0.011046924628317356,
0.03473517298698425,
0.015013947151601315,
-0.017177777364850044,
-0.0055851503275334835,
0.06912869215011597,
-0.07121659815311432,
-0.006221012677997351,
0.011967501603066921,
0.026383547112345695,
0.06878703087568283,
... |
719,642 | ibm_platform_services.iam_access_groups_v2 | list_access_group_members |
List access group members.
List all members of a given group using this API. Parameters for pagination and
sorting can be used to filter the results. The most useful query parameter may be
the `verbose` flag. If `verbose=true`, user, service ID and trusted profile names
will be... | def list_access_group_members(
self,
access_group_id: str,
*,
transaction_id: str = None,
membership_type: str = None,
limit: int = None,
offset: int = None,
type: str = None,
verbose: bool = None,
sort: str = None,
**kwargs,
) -> DetailedResponse:
"""
List access gro... | (self, access_group_id: str, *, transaction_id: Optional[str] = None, membership_type: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, type: Optional[str] = None, verbose: Optional[bool] = None, sort: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedRespon... | [
-0.018840940669178963,
0.03307567164301872,
0.020689230412244797,
-0.006256121210753918,
-0.0000249671793426387,
-0.01647009886801243,
-0.004642496816813946,
0.03026936948299408,
-0.030714508146047592,
0.02134726010262966,
0.022005289793014526,
0.013973455876111984,
0.06502882391214371,
0.... |
719,643 | ibm_platform_services.iam_access_groups_v2 | list_access_group_rules |
List access group rules.
This API lists all rules in a given access group. Because only a few rules are
created on each group, there is no pagination or sorting support on this API.
:param str access_group_id: The access group identifier.
:param str transaction_id: (optional) ... | def list_access_group_rules(
self,
access_group_id: str,
*,
transaction_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
List access group rules.
This API lists all rules in a given access group. Because only a few rules are
created on each group, there is no pagination or sortin... | (self, access_group_id: str, *, transaction_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.07980019599199295,
0.04038216173648834,
-0.005033864174038172,
-0.021433323621749878,
-0.011254348792135715,
0.00274637620896101,
-0.07980019599199295,
0.015463141724467278,
-0.01790127530694008,
0.00013304570165928453,
-0.0011703966883942485,
0.001212113769724965,
0.03150105103850365,
... |
719,644 | ibm_platform_services.iam_access_groups_v2 | list_access_groups |
List access groups.
This API lists access groups within an account. Parameters for pagination and
sorting can be used to filter the results. The `account_id` query parameter
determines which account to retrieve groups from. Only the groups you have access
to are returned (eithe... | def list_access_groups(
self,
account_id: str,
*,
transaction_id: str = None,
iam_id: str = None,
search: str = None,
membership_type: str = None,
limit: int = None,
offset: int = None,
sort: str = None,
show_federated: bool = None,
hide_public_access: bool = None,
**... | (self, account_id: str, *, transaction_id: Optional[str] = None, iam_id: Optional[str] = None, search: Optional[str] = None, membership_type: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, sort: Optional[str] = None, show_federated: Optional[bool] = None, hide_public_access: Optional[b... | [
-0.025463739410042763,
0.012761733494699001,
-0.026240194216370583,
-0.03677210956811905,
0.012483006343245506,
-0.026618467643857002,
-0.03111792542040348,
0.016912780702114105,
0.015648553147912025,
0.007645094767212868,
0.016415053978562355,
0.0036184790078550577,
0.06183766573667526,
-... |
719,645 | ibm_platform_services.iam_access_groups_v2 | list_assignments |
List assignments.
List template assignments from an enterprise account.
:param str account_id: Enterprise account ID.
:param str template_id: (optional) Filter results by Template Id.
:param str template_version: (optional) Filter results by Template Version.
:param st... | def list_assignments(
self,
account_id: str,
*,
template_id: str = None,
template_version: str = None,
target: str = None,
status: str = None,
transaction_id: str = None,
limit: int = None,
offset: int = None,
**kwargs,
) -> DetailedResponse:
"""
List assignments.
... | (self, account_id: str, *, template_id: Optional[str] = None, template_version: Optional[str] = None, target: Optional[str] = None, status: Optional[str] = None, transaction_id: Optional[str] = None, limit: Optional[int] = None, offset: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedRes... | [
0.03405033051967621,
-0.013634714297950268,
-0.06427273154258728,
-0.04684654623270035,
-0.006325195077806711,
0.026449158787727356,
-0.03765951842069626,
-0.058403242379426956,
-0.04032083973288536,
-0.00803409144282341,
0.0157309602946043,
-0.06733507663011551,
0.0018444687593728304,
-0.... |
719,646 | ibm_platform_services.iam_access_groups_v2 | list_template_versions |
List template versions.
List all the versions of an access group template.
:param str template_id: ID of the template that you want to list all
versions of.
:param int limit: (optional) Return up to this limit of results where limit
is between 0 and 100.
... | def list_template_versions(
self,
template_id: str,
*,
limit: int = None,
offset: int = None,
**kwargs,
) -> DetailedResponse:
"""
List template versions.
List all the versions of an access group template.
:param str template_id: ID of the template that you want to list all
... | (self, template_id: str, *, limit: Optional[int] = None, offset: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.04551012068986893,
-0.04683184251189232,
-0.010082599706947803,
-0.03536500781774521,
-0.04425984248518944,
0.029345812276005745,
-0.0605134554207325,
0.012520641088485718,
-0.04208078607916832,
0.006488049868494272,
0.014110280200839043,
-0.03581153601408005,
-0.044188398867845535,
-0.0... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.