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,785 | ibm_platform_services.iam_policy_management_v1 | get_policy |
Retrieve a policy by ID.
Retrieve a policy by providing a policy ID.
:param str policy_id: The policy ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedRes... | def get_policy(
self,
policy_id: str,
**kwargs,
) -> DetailedResponse:
"""
Retrieve a policy by ID.
Retrieve a policy by providing a policy ID.
:param str policy_id: The policy ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing t... | (self, policy_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.00008959904516814277,
-0.005872073117643595,
0.015031404793262482,
-0.039116546511650085,
0.045176856219768524,
-0.010091334581375122,
0.009292474947869778,
0.04829883575439453,
-0.011064657010138035,
0.0375739224255085,
-0.03039337322115898,
0.03786775469779968,
-0.015490519814193249,
... |
719,786 | ibm_platform_services.iam_policy_management_v1 | get_policy_assignment |
Retrieve a policy assignment.
Retrieve a policy template assignment by providing a policy assignment ID.
:param str assignment_id: The policy template assignment ID.
:param str version: specify version of response body format.
:param dict headers: A `dict` containing the reque... | def get_policy_assignment(
self,
assignment_id: str,
version: str,
**kwargs,
) -> DetailedResponse:
"""
Retrieve a policy assignment.
Retrieve a policy template assignment by providing a policy assignment ID.
:param str assignment_id: The policy template assignment ID.
:param str ver... | (self, assignment_id: str, version: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.016892170533537865,
0.04300788789987564,
-0.06378737837076187,
-0.03551596403121948,
0.046965885907411575,
0.01940125785768032,
-0.0390145517885685,
0.010531101375818253,
0.007668620906770229,
-0.012404082342982292,
-0.003885110607370734,
-0.016671299934387207,
-0.003374899970367551,
0.0... |
719,787 | ibm_platform_services.iam_policy_management_v1 | get_policy_template |
Retrieve latest version of a policy template.
Retrieve the latest version of a policy template by providing a policy template
ID.
:param str policy_template_id: The policy template ID.
:param str state: (optional) The policy template state.
:param dict headers: A `dict... | def get_policy_template(
self,
policy_template_id: str,
*,
state: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Retrieve latest version of a policy template.
Retrieve the latest version of a policy template by providing a policy template
ID.
:param str policy_templat... | (self, policy_template_id: str, *, state: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.052177660167217255,
-0.046537842601537704,
-0.005284995771944523,
-0.046463143080472946,
0.0004747508792206645,
-0.02250324934720993,
-0.020206237211823463,
0.026163529604673386,
0.01212934497743845,
-0.020635761320590973,
0.018264049664139748,
0.011671810410916805,
-0.07496103644371033,
... |
719,788 | ibm_platform_services.iam_policy_management_v1 | get_policy_template_version |
Retrieve a policy template version.
Retrieve a policy template by providing a policy template ID and version number.
:param str policy_template_id: The policy template ID.
:param str version: The policy template version.
:param dict headers: A `dict` containing the request hea... | def get_policy_template_version(
self,
policy_template_id: str,
version: str,
**kwargs,
) -> DetailedResponse:
"""
Retrieve a policy template version.
Retrieve a policy template by providing a policy template ID and version number.
:param str policy_template_id: The policy template ID.
... | (self, policy_template_id: str, version: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.0658894032239914,
-0.044564660638570786,
-0.023645050823688507,
-0.014649251475930214,
0.011224033311009407,
-0.03436267003417015,
-0.021306326612830162,
0.027107099071145058,
-0.005598205141723156,
0.010441389866173267,
0.014492722228169441,
0.0074167014099657536,
-0.05903896689414978,
... |
719,789 | ibm_platform_services.iam_policy_management_v1 | get_role |
Retrieve a role by ID.
Retrieve a role by providing a role ID.
:param str role_id: The role ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, headers and HTTP status code.
:rtype: DetailedResponse with... | def get_role(
self,
role_id: str,
**kwargs,
) -> DetailedResponse:
"""
Retrieve a role by ID.
Retrieve a role by providing a role ID.
:param str role_id: The role ID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedResponse` containing the result, hea... | (self, role_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.003556840354576707,
0.0026202211156487465,
0.04850993677973747,
-0.04480971395969391,
0.06068367511034012,
-0.03881534934043884,
-0.014458625577390194,
0.05147011578083038,
-0.01655850186944008,
0.001539061893709004,
-0.012765772640705109,
0.02808470092713833,
-0.03361653536558151,
-0.0... |
719,790 | ibm_platform_services.iam_policy_management_v1 | get_v2_policy |
Retrieve a policy by ID.
Retrieve a policy by providing a policy ID.
:param str id: The policy ID.
:param str format: (optional) Include additional data for policy returned
* `include_last_permit` - returns details of when the policy last granted a
permit... | def get_v2_policy(
self,
id: str,
*,
format: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Retrieve a policy by ID.
Retrieve a policy by providing a policy ID.
:param str id: The policy ID.
:param str format: (optional) Include additional data for policy returned
... | (self, id: str, *, format: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.01367759145796299,
0.01200578361749649,
-0.005309367086738348,
-0.04207076504826546,
0.04287911206483841,
-0.007527727633714676,
0.03290338069200516,
0.019014516845345497,
-0.0214946698397398,
0.03301360830664635,
-0.009920617565512657,
0.038947608321905136,
-0.03305035084486008,
-0.0289... |
719,791 | ibm_platform_services.iam_policy_management_v1 | list_policies |
Get policies by attributes.
Get policies and filter by attributes. While managing policies, you might want to
retrieve policies in the account and filter by attribute values. This can be done
through query parameters. The following attributes are supported: account_id,
iam_id, ... | def list_policies(
self,
account_id: str,
*,
accept_language: Optional[str] = None,
iam_id: Optional[str] = None,
access_group_id: Optional[str] = None,
type: Optional[str] = None,
service_type: Optional[str] = None,
tag_name: Optional[str] = None,
tag_value: Optional[str] = None... | (self, account_id: str, *, accept_language: Optional[str] = None, iam_id: Optional[str] = None, access_group_id: Optional[str] = None, type: Optional[str] = None, service_type: Optional[str] = None, tag_name: Optional[str] = None, tag_value: Optional[str] = None, sort: Optional[str] = None, format: Optional[str] = None... | [
-0.03920368105173111,
-0.012306494638323784,
-0.0335284061729908,
-0.08428388833999634,
0.023566484451293945,
0.0030112171079963446,
-0.020668471232056618,
-0.05409625172615051,
-0.03620504215359688,
0.0341925323009491,
-0.01320206094533205,
0.03598366677761078,
-0.020125092938542366,
0.01... |
719,792 | ibm_platform_services.iam_policy_management_v1 | list_policy_assignments |
Get policy template assignments.
Get policy template assignments by attributes. The following attributes are
supported:
`account_id`, `template_id`, `template_version`, `sort`.
`account_id` is a required query parameter. Only policy template assignments that
have the sp... | def list_policy_assignments(
self,
version: str,
account_id: str,
*,
accept_language: Optional[str] = None,
template_id: Optional[str] = None,
template_version: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Get policy template assignments.
Get policy template ass... | (self, version: str, account_id: str, *, accept_language: Optional[str] = None, template_id: Optional[str] = None, template_version: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.028096504509449005,
-0.02018674835562706,
-0.060616474598646164,
-0.04907048121094704,
0.014123226515948772,
0.025866027921438217,
-0.03248248249292374,
-0.05176954343914986,
-0.012998616322875023,
0.030383212491869926,
0.008420516736805439,
-0.014113854616880417,
-0.03057064674794674,
-... |
719,793 | ibm_platform_services.iam_policy_management_v1 | list_policy_template_versions |
Retrieve policy template versions.
Retrieve the versions of a policy template by providing a policy template ID.
:param str policy_template_id: The policy template ID.
:param str state: (optional) The policy template state.
:param dict headers: A `dict` containing the request ... | def list_policy_template_versions(
self,
policy_template_id: str,
*,
state: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Retrieve policy template versions.
Retrieve the versions of a policy template by providing a policy template ID.
:param str policy_template_id: The p... | (self, policy_template_id: str, *, state: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.03599659353494644,
-0.06924093514680862,
-0.011832884512841702,
-0.07130512595176697,
-0.026001565158367157,
0.0031302371062338352,
-0.04439821466803551,
0.011869098991155624,
-0.002829209202900529,
0.0046331132762134075,
0.009913548827171326,
-0.0000496526226925198,
-0.04990272596478462,
... |
719,794 | ibm_platform_services.iam_policy_management_v1 | list_policy_templates |
List policy templates by attributes.
List policy templates and filter by attributes by using query parameters. The
following attributes are supported:
`account_id`, `policy_service_name`, `policy_service_type`,
`policy_service_group_id` and `policy_type`.
`account_id` i... | def list_policy_templates(
self,
account_id: str,
*,
accept_language: Optional[str] = None,
state: Optional[str] = None,
name: Optional[str] = None,
policy_service_type: Optional[str] = None,
policy_service_name: Optional[str] = None,
policy_service_group_id: Optional[str] = None,
... | (self, account_id: str, *, accept_language: Optional[str] = None, state: Optional[str] = None, name: Optional[str] = None, policy_service_type: Optional[str] = None, policy_service_name: Optional[str] = None, policy_service_group_id: Optional[str] = None, policy_type: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_co... | [
0.005825051572173834,
-0.044416625052690506,
0.013092960231006145,
-0.09476067125797272,
-0.01979055069386959,
0.001777981175109744,
-0.03501855209469795,
-0.04219384491443634,
-0.018367191776633263,
0.01019749604165554,
0.016739102080464363,
0.02952009253203869,
-0.06134095788002014,
-0.0... |
719,795 | ibm_platform_services.iam_policy_management_v1 | list_roles |
Get roles by filters.
Get roles based on the filters. While managing roles, you may want to retrieve
roles and filter by usages. This can be done through query parameters. Currently,
we only support the following attributes: account_id, service_name,
service_group_id, source_se... | def list_roles(
self,
*,
accept_language: Optional[str] = None,
account_id: Optional[str] = None,
service_name: Optional[str] = None,
source_service_name: Optional[str] = None,
policy_type: Optional[str] = None,
service_group_id: Optional[str] = None,
**kwargs,
) -> DetailedResponse:... | (self, *, accept_language: Optional[str] = None, account_id: Optional[str] = None, service_name: Optional[str] = None, source_service_name: Optional[str] = None, policy_type: Optional[str] = None, service_group_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0349789634346962,
-0.03804036229848862,
0.04029197245836258,
-0.0733155906200409,
0.016284672543406487,
-0.012828253209590912,
-0.021410048007965088,
-0.0012023401213809848,
-0.0056389011442661285,
0.03962044045329094,
0.01775611937046051,
0.006428939756006002,
-0.006216616835445166,
0.... |
719,796 | ibm_platform_services.iam_policy_management_v1 | list_v2_policies |
Get policies by attributes.
Get policies and filter by attributes. While managing policies, you might want to
retrieve policies in the account and filter by attribute values. This can be done
through query parameters. The following attributes are supported: account_id,
iam_id, ... | def list_v2_policies(
self,
account_id: str,
*,
accept_language: Optional[str] = None,
iam_id: Optional[str] = None,
access_group_id: Optional[str] = None,
type: Optional[str] = None,
service_type: Optional[str] = None,
service_name: Optional[str] = None,
service_group_id: Option... | (self, account_id: str, *, accept_language: Optional[str] = None, iam_id: Optional[str] = None, access_group_id: Optional[str] = None, type: Optional[str] = None, service_type: Optional[str] = None, service_name: Optional[str] = None, service_group_id: Optional[str] = None, sort: Optional[str] = None, format: Optional[... | [
-0.042389754205942154,
-0.017669018357992172,
-0.03527844324707985,
-0.07182818651199341,
0.014560303650796413,
-0.014441120438277721,
0.0013619248056784272,
-0.040502674877643585,
-0.049699701368808746,
0.03774157911539078,
-0.0067835524678230286,
0.03134537488222122,
-0.040363624691963196,... |
719,798 | ibm_platform_services.iam_policy_management_v1 | replace_policy |
Update a policy.
Update a policy to grant access between a subject and a resource. A policy
administrator might want to update an existing policy. The policy type cannot be
changed (You cannot change an access policy to an authorization policy).
### Access
To update an ... | def replace_policy(
self,
policy_id: str,
if_match: str,
type: str,
subjects: List['PolicySubject'],
roles: List['PolicyRole'],
resources: List['PolicyResource'],
*,
description: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Update a policy.
Update a poli... | (self, policy_id: str, if_match: str, type: str, subjects: List[ibm_platform_services.iam_policy_management_v1.PolicySubject], roles: List[ibm_platform_services.iam_policy_management_v1.PolicyRole], resources: List[ibm_platform_services.iam_policy_management_v1.PolicyResource], *, description: Optional[str] = None, **k... | [
0.023052718490362167,
-0.021361136808991432,
-0.03035012260079384,
-0.0492132268846035,
0.0035675654653459787,
-0.050196703523397446,
-0.012460662983357906,
-0.018518885597586632,
-0.005143588408827782,
0.04162077605724335,
-0.02856019325554371,
0.008693942800164223,
-0.015106217935681343,
... |
719,799 | ibm_platform_services.iam_policy_management_v1 | replace_policy_template |
Update a policy template version.
Update a specific version of a policy template. You can use this only if the
version isn't committed.
:param str policy_template_id: The policy template ID.
:param str version: The policy template version.
:param str if_match: The revi... | def replace_policy_template(
self,
policy_template_id: str,
version: str,
if_match: str,
policy: 'TemplatePolicy',
*,
name: Optional[str] = None,
description: Optional[str] = None,
committed: Optional[bool] = None,
**kwargs,
) -> DetailedResponse:
"""
Update a policy temp... | (self, policy_template_id: str, version: str, if_match: str, policy: ibm_platform_services.iam_policy_management_v1.TemplatePolicy, *, name: Optional[str] = None, description: Optional[str] = None, committed: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.07080131024122238,
-0.07064773142337799,
-0.03966255858540535,
-0.028163103386759758,
-0.003328410442918539,
-0.05571188032627106,
-0.02069517783820629,
0.03353847563266754,
-0.007184759248048067,
0.00510660232976079,
0.007439129054546356,
-0.03280895948410034,
-0.05037490278482437,
-0.0... |
719,800 | ibm_platform_services.iam_policy_management_v1 | replace_role |
Update a role.
Update a custom role. A role administrator might want to update an existing role
by updating the display name, description, or the actions that are mapped to the
role. The name, account_id, and service_name can't be changed.
:param str role_id: The role ID.
... | def replace_role(
self,
role_id: str,
if_match: str,
display_name: str,
actions: List[str],
*,
description: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Update a role.
Update a custom role. A role administrator might want to update an existing role
by updati... | (self, role_id: str, if_match: str, display_name: str, actions: List[str], *, description: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.02725270576775074,
-0.03271478787064552,
0.023963918909430504,
-0.047504719346761703,
0.025060180574655533,
-0.04792783781886101,
-0.019982753321528435,
0.04419669508934021,
-0.011847330257296562,
0.03233013302087784,
-0.006447755731642246,
0.006952613592147827,
-0.036426693201065063,
0.... |
719,801 | ibm_platform_services.iam_policy_management_v1 | replace_v2_policy |
Update a policy.
Update a policy to grant access between a subject and a resource. A policy
administrator might want to update an existing policy.
### Access
To update an access policy, use **`"type": "access"`** in the body. The supported
subject attributes are **`iam_... | def replace_v2_policy(
self,
id: str,
if_match: str,
control: 'Control',
type: str,
*,
description: Optional[str] = None,
subject: Optional['V2PolicySubject'] = None,
resource: Optional['V2PolicyResource'] = None,
pattern: Optional[str] = None,
rule: Optional['V2PolicyRule'] ... | (self, id: str, if_match: str, control: ibm_platform_services.iam_policy_management_v1.Control, type: str, *, description: Optional[str] = None, subject: Optional[ibm_platform_services.iam_policy_management_v1.V2PolicySubject] = None, resource: Optional[ibm_platform_services.iam_policy_management_v1.V2PolicyResource] =... | [
0.034669529646635056,
-0.0034628671128302813,
-0.0232696495950222,
-0.041493114084005356,
0.029684636741876602,
-0.05687682703137398,
0.0033785938285291195,
-0.035772744566202164,
-0.045722104609012604,
0.018958942964673042,
-0.0007974043255671859,
0.030031945556402206,
0.005041076336055994,... |
719,809 | ibm_platform_services.iam_policy_management_v1 | update_policy_assignment |
Update a policy authorization type assignment.
Update a policy assignment by providing a policy assignment ID.
:param str assignment_id: The policy template assignment ID.
:param str version: specify version of response body format.
:param str if_match: The revision number for... | def update_policy_assignment(
self,
assignment_id: str,
version: str,
if_match: str,
template_version: str,
**kwargs,
) -> DetailedResponse:
"""
Update a policy authorization type assignment.
Update a policy assignment by providing a policy assignment ID.
:param str assignment_id... | (self, assignment_id: str, version: str, if_match: str, template_version: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.026258109137415886,
0.02440587617456913,
-0.06809675693511963,
-0.04194759950041771,
0.028419045731425285,
-0.016869835555553436,
-0.0461968369781971,
-0.014599944464862347,
-0.029072774574160576,
-0.010913640260696411,
0.009361034259200096,
-0.05222567170858383,
0.005906258709728718,
0.... |
719,810 | ibm_platform_services.iam_policy_management_v1 | update_policy_state |
Restore a deleted policy by ID.
Restore a policy that has recently been deleted. A policy administrator might want
to restore a deleted policy. To restore a policy, use **`"state": "active"`** in
the body.
:param str policy_id: The policy ID.
:param str if_match: The r... | def update_policy_state(
self,
policy_id: str,
if_match: str,
*,
state: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Restore a deleted policy by ID.
Restore a policy that has recently been deleted. A policy administrator might want
to restore a deleted policy. To re... | (self, policy_id: str, if_match: str, *, state: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.004818249959498644,
-0.014280140399932861,
-0.03484618663787842,
-0.06376512348651886,
0.005054207053035498,
-0.0647844597697258,
-0.011580788530409336,
0.012156524695456028,
0.007885695435106754,
0.00006282365211518481,
-0.04685169830918312,
0.01433677040040493,
-0.02648385614156723,
0.... |
719,811 | ibm_platform_services.ibm_cloud_shell_v1 | IbmCloudShellV1 | The IBM Cloud Shell V1 service. | class IbmCloudShellV1(BaseService):
"""The IBM Cloud Shell V1 service."""
DEFAULT_SERVICE_URL = 'https://api.shell.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'ibm_cloud_shell'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'IbmCloudShellV1':
... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.01092400960624218,
-0.06874555349349976,
-0.04123002663254738,
-0.015866853296756744,
0.041294921189546585,
0.005251096095889807,
-0.05126713588833809,
-0.0002845920971594751,
-0.015628905966877937,
-0.009404382668435574,
0.007300699595361948,
-0.023989558219909668,
-0.014309371821582317,
... |
719,812 | ibm_platform_services.ibm_cloud_shell_v1 | __init__ |
Construct a new client for the IBM Cloud Shell 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 authen... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the IBM Cloud Shell service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-c... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.009553279727697372,
-0.0810161828994751,
-0.008428560569882393,
-0.023405078798532486,
0.008351150900125504,
-0.006320281885564327,
0.014425543136894703,
0.046300165355205536,
-0.001525428262539208,
-0.009453102014958858,
0.007954995147883892,
0.025973262265324593,
-0.07016059756278992,
... |
719,821 | ibm_platform_services.ibm_cloud_shell_v1 | get_account_settings |
Get account settings.
Retrieve account settings for the given account ID. Call this method to get
details about a particular account setting, whether Cloud Shell is enabled, the
list of enabled regions and the list of enabled features. Users need to be an
account owner or users... | def get_account_settings(self, account_id: str, **kwargs) -> DetailedResponse:
"""
Get account settings.
Retrieve account settings for the given account ID. Call this method to get
details about a particular account setting, whether Cloud Shell is enabled, the
list of enabled regions and the list of... | (self, account_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.04865701124072075,
-0.02497071772813797,
-0.003886327613145113,
-0.025764038786292076,
0.035208333283662796,
0.033073924481868744,
-0.043670423328876495,
-0.03277170658111572,
-0.013146459124982357,
-0.016574738547205925,
0.021098555997014046,
-0.015091984532773495,
-0.012296472676098347,... |
719,833 | ibm_platform_services.ibm_cloud_shell_v1 | update_account_settings |
Update account settings.
Update account settings for the given account ID. Call this method to update
account settings configuration, you can enable or disable Cloud Shell, enable or
disable available regions and enable and disable features. To update account
settings, users ne... | def update_account_settings(
self,
account_id: str,
*,
rev: str = None,
default_enable_new_features: bool = None,
default_enable_new_regions: bool = None,
enabled: bool = None,
features: List['Feature'] = None,
regions: List['RegionSetting'] = None,
**kwargs
) -> DetailedResponse... | (self, account_id: str, *, rev: Optional[str] = None, default_enable_new_features: Optional[bool] = None, default_enable_new_regions: Optional[bool] = None, enabled: Optional[bool] = None, features: Optional[List[ibm_platform_services.ibm_cloud_shell_v1.Feature]] = None, regions: Optional[List[ibm_platform_services.ibm... | [
-0.015378221869468689,
-0.011112070642411709,
-0.01913243532180786,
0.010032985359430313,
0.004027748946100473,
-0.022866573184728622,
-0.05010971799492836,
-0.006961355917155743,
-0.039449356496334076,
0.015378221869468689,
0.014494878239929676,
-0.024733642116189003,
-0.018961789086461067,... |
719,834 | ibm_platform_services.open_service_broker_v1 | OpenServiceBrokerV1 | The Open Service Broker V1 service. | class OpenServiceBrokerV1(BaseService):
"""The Open Service Broker V1 service."""
DEFAULT_SERVICE_URL = None
DEFAULT_SERVICE_NAME = 'open_service_broker'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'OpenServiceBrokerV1':
"""
... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.06394939869642258,
-0.12089402228593826,
-0.03768152371048927,
-0.02468149922788143,
0.014751213602721691,
-0.03582732006907463,
-0.0103989876806736,
0.02744220197200775,
-0.001210382441058755,
-0.01976786181330681,
-0.04837409034371376,
-0.016677524894475937,
0.0012683263048529625,
-0.0... |
719,835 | ibm_platform_services.open_service_broker_v1 | __init__ |
Construct a new client for the Open Service Broker 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 au... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Open Service Broker service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-s... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.013409093953669071,
-0.08178725838661194,
-0.010953650809824467,
0.004404280334711075,
0.009538804180920124,
-0.04001733660697937,
0.013810727745294571,
0.04699116200208664,
0.002150794956833124,
-0.009169118478894234,
-0.014422306790947914,
0.013381710276007652,
-0.031473491340875626,
... |
719,841 | ibm_platform_services.open_service_broker_v1 | delete_service_binding |
Delete (unbind) the credentials bound to a resource.
Delete instance binding by GUID.
When a broker receives an unbind request from the IBM Cloud platform, it MUST
delete any resources associated with the binding. In the case where credentials
were generated, this might result ... | def delete_service_binding(
self, binding_id: str, instance_id: str, plan_id: str, service_id: str, **kwargs
) -> DetailedResponse:
"""
Delete (unbind) the credentials bound to a resource.
Delete instance binding by GUID.
When a broker receives an unbind request from the IBM Cloud platform, it MUST
... | (self, binding_id: str, instance_id: str, plan_id: str, service_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.029855087399482727,
-0.1055934950709343,
0.020230868831276894,
-0.061456725001335144,
-0.029072778299450874,
-0.00018051093502435833,
-0.005239649675786495,
0.11607279628515244,
0.03554956614971161,
-0.028144923970103264,
-0.050613559782505035,
0.006590496748685837,
-0.012307718396186829,
... |
719,842 | ibm_platform_services.open_service_broker_v1 | delete_service_instance |
Delete (deprovision) a service instance.
Delete (deprovision) a service instance by GUID. When a service broker receives a
deprovision request from the IBM Cloud platform, it MUST delete any resources it
created during the provision. Usually this means that all resources are
im... | def delete_service_instance(
self, service_id: str, plan_id: str, instance_id: str, *, accepts_incomplete: bool = None, **kwargs
) -> DetailedResponse:
"""
Delete (deprovision) a service instance.
Delete (deprovision) a service instance by GUID. When a service broker receives a
deprovision request f... | (self, service_id: str, plan_id: str, instance_id: str, *, accepts_incomplete: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.07046572864055634,
-0.07039225101470947,
0.012087187729775906,
-0.03394699469208717,
-0.038759827613830566,
-0.039862003177404404,
0.03076905570924282,
0.06377920508384705,
-0.0003088386729359627,
0.05360245332121849,
-0.01678980141878128,
-0.031963080167770386,
-0.0033111178781837225,
-... |
719,849 | ibm_platform_services.open_service_broker_v1 | get_last_operation |
Get the current status of a provision in-progress for a service instance.
Get `last_operation` for instance by GUID (for asynchronous provision calls). When
a broker returns status code `202 Accepted` during a provision, update, or
deprovision call, the IBM Cloud platform will begin po... | def get_last_operation(
self, instance_id: str, *, operation: str = None, plan_id: str = None, service_id: str = None, **kwargs
) -> DetailedResponse:
"""
Get the current status of a provision in-progress for a service instance.
Get `last_operation` for instance by GUID (for asynchronous provision calls... | (self, instance_id: str, *, operation: Optional[str] = None, plan_id: Optional[str] = None, service_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.03684433177113533,
-0.10992399603128433,
-0.008359437808394432,
0.03208654001355171,
-0.026434283703565598,
-0.04746371880173683,
0.003939450718462467,
0.0019102529622614384,
0.013673890382051468,
-0.040802810341119766,
0.010781153105199337,
-0.02900349162518978,
0.005590403918176889,
-0... |
719,850 | ibm_platform_services.open_service_broker_v1 | get_service_instance_state |
Get the current state of the service instance.
Get the current state information associated with the service instance.
As a service provider you need a way to manage provisioned service instances. If
an account comes past due, you may need a to disable the service (without deleting
... | def get_service_instance_state(self, instance_id: str, **kwargs) -> DetailedResponse:
"""
Get the current state of the service instance.
Get the current state information associated with the service instance.
As a service provider you need a way to manage provisioned service instances. If
an accoun... | (self, instance_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.05349864438176155,
-0.12370150536298752,
0.013337038457393646,
-0.018096236512064934,
0.015321604907512665,
-0.0078959409147501,
-0.010336675681173801,
0.004121972713619471,
0.01038370281457901,
-0.040669504553079605,
-0.03436779975891113,
-0.008098159916698933,
0.0046087088994681835,
-0... |
719,851 | ibm_platform_services.open_service_broker_v1 | list_catalog |
Get the catalog metadata stored within the broker.
This endpoints defines the contract between the broker and the IBM Cloud platform
for the services and plans that the broker supports. This endpoint returns the
catalog metadata stored within your broker. These values define the minima... | def list_catalog(self, **kwargs) -> DetailedResponse:
"""
Get the catalog metadata stored within the broker.
This endpoints defines the contract between the broker and the IBM Cloud platform
for the services and plans that the broker supports. This endpoint returns the
catalog metadata stored within... | (self, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.029048865661025047,
-0.0678461566567421,
-0.02992372401058674,
-0.041957490146160126,
0.03956501930952072,
0.02290700376033783,
0.011908785440027714,
0.01456014160066843,
0.027620526030659676,
-0.02713846229016781,
-0.02256777323782444,
0.014658340252935886,
-0.0036244129296392202,
-0.0... |
719,853 | ibm_platform_services.open_service_broker_v1 | replace_service_binding |
Bind a service instance to another resource.
Create binding by GUID on service instance.
If your service can be bound to applications in IBM Cloud, `bindable:true` must be
specified in the catalog.json of your service broker. If bindable, it must be able
to return API endpoints... | def replace_service_binding(
self,
binding_id: str,
instance_id: str,
*,
plan_id: str = None,
service_id: str = None,
bind_resource: 'BindResource' = None,
parameters: dict = None,
**kwargs
) -> DetailedResponse:
"""
Bind a service instance to another resource.
Create bin... | (self, binding_id: str, instance_id: str, *, plan_id: Optional[str] = None, service_id: Optional[str] = None, bind_resource: Optional[ibm_platform_services.open_service_broker_v1.BindResource] = None, parameters: Optional[dict] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.06524164229631424,
-0.11253402382135391,
-0.009598948992788792,
-0.04499019682407379,
-0.021012334153056145,
-0.010447637178003788,
0.009794049896299839,
0.09044864028692245,
0.03582046926021576,
-0.04588766023516655,
-0.06442221999168396,
-0.008720996789634228,
-0.009028280153870583,
-0... |
719,854 | ibm_platform_services.open_service_broker_v1 | replace_service_instance |
Create (provision) a service instance.
Create a service instance with GUID. When your service broker receives a provision
request from the IBM Cloud platform, it MUST take whatever action is necessary to
create a new resource.
When a user creates a service instance from the IBM... | def replace_service_instance(
self,
instance_id: str,
*,
organization_guid: str = None,
plan_id: str = None,
service_id: str = None,
space_guid: str = None,
context: 'Context' = None,
parameters: dict = None,
accepts_incomplete: bool = None,
**kwargs
) -> DetailedResponse:
... | (self, instance_id: str, *, organization_guid: Optional[str] = None, plan_id: Optional[str] = None, service_id: Optional[str] = None, space_guid: Optional[str] = None, context: Optional[ibm_platform_services.open_service_broker_v1.Context] = None, parameters: Optional[dict] = None, accepts_incomplete: Optional[bool] = ... | [
0.09665744006633759,
-0.06496777385473251,
-0.02575281262397766,
-0.02942611277103424,
-0.013074963353574276,
-0.04014817997813225,
0.03591892123222351,
0.029982073232531548,
0.012231097556650639,
0.033039845526218414,
-0.020352069288492203,
-0.04539007693529129,
0.0007067380356602371,
-0.... |
719,855 | ibm_platform_services.open_service_broker_v1 | replace_service_instance_state |
Update the state of a provisioned service instance.
Update (disable or enable) the state of a provisioned service instance. As a
service provider you need a way to manage provisioned service instances. If an
account comes past due, you may need a to disable the service (without deletin... | def replace_service_instance_state(
self, instance_id: str, *, enabled: bool = None, initiator_id: str = None, reason_code: str = None, **kwargs
) -> DetailedResponse:
"""
Update the state of a provisioned service instance.
Update (disable or enable) the state of a provisioned service instance. As a
... | (self, instance_id: str, *, enabled: Optional[bool] = None, initiator_id: Optional[str] = None, reason_code: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.07049019634723663,
-0.10563905537128448,
0.006053841672837734,
-0.028199929744005203,
-0.00334934308193624,
-0.0416935458779335,
-0.008036498911678791,
0.01779579184949398,
0.022867929190397263,
-0.0048555852845311165,
-0.05332000181078911,
-0.02640976384282112,
0.00008759844058658928,
-... |
719,863 | ibm_platform_services.open_service_broker_v1 | update_service_instance |
Update a service instance.
Patch an instance by GUID. Enabling this endpoint allows your user to change plans
and service parameters in a provisioned service instance. If your offering
supports multiple plans, and you want users to be able to change plans for a
provisioned inst... | def update_service_instance(
self,
instance_id: str,
*,
service_id: str = None,
context: 'Context' = None,
parameters: dict = None,
plan_id: str = None,
previous_values: dict = None,
accepts_incomplete: bool = None,
**kwargs
) -> DetailedResponse:
"""
Update a service ins... | (self, instance_id: str, *, service_id: Optional[str] = None, context: Optional[ibm_platform_services.open_service_broker_v1.Context] = None, parameters: Optional[dict] = None, plan_id: Optional[str] = None, previous_values: Optional[dict] = None, accepts_incomplete: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_co... | [
0.10953570902347565,
-0.08776950091123581,
-0.01394642423838377,
-0.030202573165297508,
-0.026385655626654625,
-0.05543336644768715,
0.003200337290763855,
0.0024761019740253687,
0.0037753216456621885,
0.05433722585439682,
-0.037738535553216934,
-0.05073562264442444,
0.03681856021285057,
-0... |
719,864 | ibm_platform_services.partner_billing_units_v1 | PartnerBillingUnitsV1 | The Partner Billing Units V1 service. | class PartnerBillingUnitsV1(BaseService):
"""The Partner Billing Units V1 service."""
DEFAULT_SERVICE_URL = 'https://partner.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'partner_billing_units'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'Partner... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.005390951409935951,
-0.046306755393743515,
-0.03955107182264328,
-0.01012306660413742,
-0.02691815420985222,
-0.022776899859309196,
-0.03810790926218033,
-0.01861472986638546,
-0.03434313088655472,
-0.03628826513886452,
-0.01916898973286152,
-0.014076082967221737,
0.007864200510084629,
-... |
719,865 | ibm_platform_services.partner_billing_units_v1 | __init__ |
Construct a new client for the Partner 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 au... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Partner Billing Units 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.012011813931167126,
-0.06010446324944496,
-0.02589394710958004,
-0.0010321942390874028,
-0.037406403571367264,
-0.038060106337070465,
-0.008085048757493496,
0.008075970225036144,
-0.04321710765361786,
-0.0022391637321561575,
0.0010997210629284382,
0.015280334278941154,
-0.0503352172672748... |
719,875 | ibm_platform_services.partner_billing_units_v1 | get_billing_options |
Get customers billing options.
Returns the billing options for the requested customer for a given month.
:param str partner_id: Enterprise ID of the distributor or reseller for
which the report is requested.
:param str customer_id: (optional) Enterprise ID of the custom... | def get_billing_options(
self,
partner_id: str,
*,
customer_id: Optional[str] = None,
reseller_id: Optional[str] = None,
date: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> DetailedResponse:
"""
Get customers billing options.
Returns the billing options fo... | (self, partner_id: str, *, customer_id: Optional[str] = None, reseller_id: Optional[str] = None, date: Optional[str] = None, limit: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.019707288593053818,
-0.009324466809630394,
0.012025095522403717,
-0.015747584402561188,
-0.0413123182952404,
-0.024104934185743332,
-0.005478808656334877,
-0.04087437689304352,
-0.06226043403148651,
-0.03704240545630455,
-0.0026664144825190306,
-0.0010566436685621738,
-0.00266185263171792... |
719,876 | ibm_platform_services.partner_billing_units_v1 | get_credit_pools_report |
Get subscription burn-down report.
Returns the subscription or commitment burn-down reports for the end customers for
a given month.
:param str partner_id: Enterprise ID of the distributor or reseller for
which the report is requested.
:param str customer_id: (o... | def get_credit_pools_report(
self,
partner_id: str,
*,
customer_id: Optional[str] = None,
reseller_id: Optional[str] = None,
date: Optional[str] = None,
limit: Optional[int] = None,
**kwargs,
) -> DetailedResponse:
"""
Get subscription burn-down report.
Returns the subscripti... | (self, partner_id: str, *, customer_id: Optional[str] = None, reseller_id: Optional[str] = None, date: Optional[str] = None, limit: Optional[int] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.055874522775411606,
-0.006693869363516569,
-0.033455733209848404,
0.019550636410713196,
-0.060921020805835724,
-0.006875398103147745,
-0.008536385372281075,
-0.003047412494197488,
-0.05188089236617088,
-0.0195687897503376,
-0.01818009652197361,
0.03599713370203972,
0.01358742080628872,
... |
719,887 | ibm_platform_services.partner_usage_reports_v1 | PartnerUsageReportsV1 | The Partner Usage Reports V1 service. | class PartnerUsageReportsV1(BaseService):
"""The Partner Usage Reports V1 service."""
DEFAULT_SERVICE_URL = 'https://partner.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'partner_usage_reports'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'Partner... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
-0.009877792559564114,
-0.08721581101417542,
-0.02463866025209427,
0.013862887397408485,
-0.018415894359350204,
-0.026910310611128807,
-0.020639004185795784,
-0.016018042340874672,
-0.051646050065755844,
-0.04022955521941185,
0.0004659794212784618,
-0.0017547036986798048,
0.02419209666550159... |
719,888 | ibm_platform_services.partner_usage_reports_v1 | __init__ |
Construct a new client for the Partner 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 au... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Partner Usage Reports 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.03312767297029495,
-0.07934728264808655,
-0.011482572183012962,
0.006225000601261854,
-0.022350329905748367,
-0.027485841885209084,
-0.002992701716721058,
0.01725098304450512,
-0.0352795235812664,
-0.005795534234493971,
0.0003447032067924738,
0.02258540503680706,
-0.04046928510069847,
-... |
719,900 | ibm_platform_services.partner_usage_reports_v1 | get_resource_usage_report |
Get partner resource usage report.
Returns the summary for the partner for a given month. Partner billing managers
are authorized to access this report.
:param str partner_id: Enterprise ID of the distributor or reseller for
which the report is requested.
:param... | def get_resource_usage_report(
self,
partner_id: str,
*,
reseller_id: Optional[str] = None,
customer_id: Optional[str] = None,
children: Optional[bool] = None,
month: Optional[str] = None,
viewpoint: Optional[str] = None,
recurse: Optional[bool] = None,
limit: Optional[int] = Non... | (self, partner_id: str, *, reseller_id: Optional[str] = None, customer_id: Optional[str] = None, children: Optional[bool] = None, month: Optional[str] = None, viewpoint: Optional[str] = None, recurse: Optional[bool] = None, limit: Optional[int] = None, offset: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detai... | [
-0.05030149593949318,
-0.03616567328572273,
0.008017947897315025,
0.020910000428557396,
-0.036918360739946365,
-0.022727463394403458,
0.0245265681296587,
-0.009830821305513382,
-0.08349313586950302,
-0.03965373337268829,
0.015815597027540207,
0.049530450254678726,
0.039690449833869934,
-0.... |
719,909 | ibm_platform_services.resource_controller_v2 | ResourceControllerV2 | The resource_controller V2 service. | class ResourceControllerV2(BaseService):
"""The resource_controller V2 service."""
DEFAULT_SERVICE_URL = 'https://resource-controller.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'resource_controller'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> '... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.05620044842362404,
-0.08611613512039185,
-0.0627913698554039,
-0.06077857315540314,
-0.005653591360896826,
-0.018963703885674477,
0.004723659250885248,
-0.01788823865354061,
-0.0248836949467659,
-0.018835438415408134,
-0.018351972103118896,
-0.0003255995106883347,
0.01516504306346178,
-0... |
719,910 | ibm_platform_services.resource_controller_v2 | __init__ |
Construct a new client for the resource_controller 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 auth... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the resource_controller service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-s... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.026023373007774353,
-0.058961525559425354,
-0.030428757891058922,
-0.024796556681394577,
0.0038802707567811012,
-0.03262215480208397,
0.00018457425176165998,
0.04576395824551582,
-0.006110845599323511,
-0.010400054976344109,
0.001191963441669941,
0.017863186076283455,
-0.03089345991611480... |
719,915 | ibm_platform_services.resource_controller_v2 | cancel_lastop_resource_instance |
Cancel the in progress last operation of the resource instance.
Cancel the in progress last operation of the resource instance. After successful
cancellation, the resource instance is removed.
:param str id: The resource instance URL-encoded CRN or GUID.
:param dict headers: A... | def cancel_lastop_resource_instance(self, id: str, **kwargs) -> DetailedResponse:
"""
Cancel the in progress last operation of the resource instance.
Cancel the in progress last operation of the resource instance. After successful
cancellation, the resource instance is removed.
:param str id: The re... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.018620556220412254,
-0.05205938220024109,
-0.01959777995944023,
-0.03837824612855911,
-0.02777092531323433,
-0.05653684213757515,
0.00939023308455944,
0.021196873858571053,
0.04914547875523567,
-0.010216431692242622,
-0.010056521743535995,
-0.03487800806760788,
0.016897089779376984,
-0.0... |
719,917 | ibm_platform_services.resource_controller_v2 | create_resource_alias |
Create a new resource alias.
Alias a resource instance into a targeted environment's (name)space.
:param str name: The name of the alias. Must be 180 characters or less and
cannot include any special characters other than `(space) - . _ :`.
:param str source: The ID of ... | def create_resource_alias(self, name: str, source: str, target: str, **kwargs) -> DetailedResponse:
"""
Create a new resource alias.
Alias a resource instance into a targeted environment's (name)space.
:param str name: The name of the alias. Must be 180 characters or less and
cannot include a... | (self, name: str, source: str, target: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.034505654126405716,
-0.060982588678598404,
0.011855742894113064,
-0.03372062370181084,
-0.014335725456476212,
0.0057583763264119625,
-0.07118798047304153,
0.005075935274362564,
0.03480895981192589,
-0.055023495107889175,
0.008251739665865898,
0.024246733635663986,
0.0625169649720192,
-0... |
719,918 | ibm_platform_services.resource_controller_v2 | create_resource_binding |
Create a new resource binding.
A resource binding connects credentials to a resource alias. The credentials are
in the form of a resource key.
:param str source: The ID of resource alias.
:param str target: The CRN of application to bind to in a specific
environ... | def create_resource_binding(
self,
source: str,
target: str,
*,
name: str = None,
parameters: 'ResourceBindingPostParameters' = None,
role: str = None,
**kwargs,
) -> DetailedResponse:
"""
Create a new resource binding.
A resource binding connects credentials to a resource al... | (self, source: str, target: str, *, name: Optional[str] = None, parameters: Optional[ibm_platform_services.resource_controller_v2.ResourceBindingPostParameters] = None, role: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.007638364564627409,
-0.04890819266438484,
-0.016447504982352257,
-0.08482455462217331,
-0.018675753846764565,
-0.012075980193912983,
-0.047019846737384796,
0.05007896572351456,
0.028476275503635406,
-0.07228592783212662,
-0.009724987670779228,
0.06586554646492004,
0.01881738007068634,
-0... |
719,919 | ibm_platform_services.resource_controller_v2 | create_resource_instance |
Create (provision) a new resource instance.
When you provision a service you get an instance of that service. An instance
represents the resource with which you create, and additionally, represents a
chargeable record of which billing can occur.
:param str name: The name of th... | def create_resource_instance(
self,
name: str,
target: str,
resource_group: str,
resource_plan_id: str,
*,
tags: List[str] = None,
allow_cleanup: bool = None,
parameters: dict = None,
entity_lock: bool = None,
**kwargs,
) -> DetailedResponse:
"""
Create (provision) a ... | (self, name: str, target: str, resource_group: str, resource_plan_id: str, *, tags: Optional[List[str]] = None, allow_cleanup: Optional[bool] = None, parameters: Optional[dict] = None, entity_lock: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.048433031886816025,
-0.05071044713258743,
-0.02011716738343239,
-0.06407128274440765,
-0.0410693883895874,
-0.02658882364630699,
0.01793464459478855,
0.004526362754404545,
-0.023685118183493614,
-0.02465302124619484,
-0.007605618331581354,
0.022356627508997917,
0.009811864234507084,
-0.0... |
719,920 | ibm_platform_services.resource_controller_v2 | create_resource_key |
Create a new resource key.
A resource key is a saved credential you can use to authenticate with a resource
instance.
:param str name: The name of the key.
:param str source: The ID of resource instance or alias.
:param ResourceKeyPostParameters parameters: (optional) ... | def create_resource_key(
self, name: str, source: str, *, parameters: 'ResourceKeyPostParameters' = None, role: str = None, **kwargs
) -> DetailedResponse:
"""
Create a new resource key.
A resource key is a saved credential you can use to authenticate with a resource
instance.
:param str name: T... | (self, name: str, source: str, *, parameters: Optional[ibm_platform_services.resource_controller_v2.ResourceKeyPostParameters] = None, role: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.03534333035349846,
-0.037230510264635086,
-0.07680624723434448,
-0.03391420841217041,
0.015692878514528275,
-0.035966284573078156,
-0.02869240939617157,
0.01495999563485384,
0.0528409369289875,
-0.02684187702834606,
0.016425762325525284,
0.05368375405669212,
0.08464810252189636,
-0.0248... |
719,921 | ibm_platform_services.resource_controller_v2 | delete_resource_alias |
Delete a resource alias.
Delete a resource alias by URL-encoded CRN or GUID. If the resource alias has any
resource keys or bindings associated with it, use the `recursive=true` parameter
to delete it.
:param str id: The resource alias URL-encoded CRN or GUID.
:param b... | def delete_resource_alias(self, id: str, *, recursive: bool = None, **kwargs) -> DetailedResponse:
"""
Delete a resource alias.
Delete a resource alias by URL-encoded CRN or GUID. If the resource alias has any
resource keys or bindings associated with it, use the `recursive=true` parameter
to delete... | (self, id: str, *, recursive: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.01576918549835682,
-0.026189863681793213,
0.07673326879739761,
-0.027063453570008278,
-0.021875400096178055,
0.024603139609098434,
-0.04991941526532173,
0.026867341250181198,
0.022659847512841225,
-0.0299694761633873,
-0.009172691963613033,
0.029898162931203842,
0.05227275565266609,
-0.... |
719,922 | ibm_platform_services.resource_controller_v2 | delete_resource_binding |
Delete a resource binding.
Deleting a resource binding does not affect the resource alias that the binding is
associated with.
:param str id: The resource binding URL-encoded CRN or GUID.
:param dict headers: A `dict` containing the request headers
:return: A `Detailed... | def delete_resource_binding(self, id: str, **kwargs) -> DetailedResponse:
"""
Delete a resource binding.
Deleting a resource binding does not affect the resource alias that the binding is
associated with.
:param str id: The resource binding URL-encoded CRN or GUID.
:param dict headers: A `dict` ... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0027695195749402046,
-0.06337939202785492,
0.012516098096966743,
-0.08727537840604782,
-0.008148779161274433,
0.016350818797945976,
-0.018445711582899094,
0.10779822617769241,
0.025014443323016167,
-0.06682354211807251,
-0.044738393276929855,
0.03460124135017395,
-0.01030580885708332,
-... |
719,923 | ibm_platform_services.resource_controller_v2 | delete_resource_instance |
Delete a resource instance.
Delete a resource instance by URL-encoded CRN or GUID. If the resource instance
has any resource keys or aliases associated with it, use the `recursive=true`
parameter to delete it.
:param str id: The resource instance URL-encoded CRN or GUID.
... | def delete_resource_instance(self, id: str, *, recursive: bool = None, **kwargs) -> DetailedResponse:
"""
Delete a resource instance.
Delete a resource instance by URL-encoded CRN or GUID. If the resource instance
has any resource keys or aliases associated with it, use the `recursive=true`
paramete... | (self, id: str, *, recursive: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.04936015233397484,
-0.048717256635427475,
0.025358688086271286,
-0.06443250179290771,
-0.03312702104449272,
-0.026555189862847328,
0.008902328088879585,
0.03394849970936775,
0.031412627547979355,
0.035252150148153305,
0.004410983063280582,
0.020519107580184937,
0.03760943561792374,
-0.03... |
719,924 | ibm_platform_services.resource_controller_v2 | delete_resource_key |
Delete a resource key.
Deleting a resource key does not affect any resource instance or resource alias
associated with the key.
:param str id: The resource key URL-encoded CRN or GUID.
:param dict headers: A `dict` containing the request headers
:return: A `DetailedRes... | def delete_resource_key(self, id: str, **kwargs) -> DetailedResponse:
"""
Delete a resource key.
Deleting a resource key does not affect any resource instance or resource alias
associated with the key.
:param str id: The resource key URL-encoded CRN or GUID.
:param dict headers: A `dict` contain... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.014644871465861797,
-0.030938858166337013,
-0.03179926797747612,
-0.03717682138085365,
0.004691915586590767,
0.006076635792851448,
-0.015343952924013138,
0.04811117798089981,
0.029540695250034332,
-0.025095250457525253,
-0.016544939950108528,
0.01520951371639967,
0.056464314460754395,
-... |
719,931 | ibm_platform_services.resource_controller_v2 | get_resource_alias |
Get a resource alias.
View a resource alias and all of its details, like who created it and the resource
instance that it's associated with.
:param str id: The resource alias URL-encoded CRN or GUID.
:param dict headers: A `dict` containing the request headers
:return:... | def get_resource_alias(self, id: str, **kwargs) -> DetailedResponse:
"""
Get a resource alias.
View a resource alias and all of its details, like who created it and the resource
instance that it's associated with.
:param str id: The resource alias URL-encoded CRN or GUID.
:param dict headers: A ... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.001465648994781077,
-0.04384973272681236,
0.05303831025958061,
-0.010252891108393669,
0.026164384558796883,
0.0260402150452137,
-0.01967206969857216,
-0.016541212797164917,
0.03592059388756752,
-0.05470573529601097,
-0.016975807026028633,
0.003955699969083071,
0.03592059388756752,
-0.02... |
719,932 | ibm_platform_services.resource_controller_v2 | get_resource_binding |
Get a resource binding.
View a resource binding and all of its details, like who created it, the
credential, and the resource alias that the binding is associated with.
:param str id: The resource binding URL-encoded CRN or GUID.
:param dict headers: A `dict` containing the re... | def get_resource_binding(self, id: str, **kwargs) -> DetailedResponse:
"""
Get a resource binding.
View a resource binding and all of its details, like who created it, the
credential, and the resource alias that the binding is associated with.
:param str id: The resource binding URL-encoded CRN or G... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.029493894428014755,
-0.07458309084177017,
0.005460160784423351,
-0.06667713820934296,
0.020360535010695457,
0.013826390728354454,
0.014052017591893673,
0.036569539457559586,
0.025179915130138397,
-0.08035913109779358,
-0.03675004094839096,
0.031623806804418564,
0.002053200965747237,
-0.0... |
719,933 | ibm_platform_services.resource_controller_v2 | get_resource_instance |
Get a resource instance.
Retrieve a resource instance by URL-encoded CRN or GUID. Find more details on a
particular instance, like when it was provisioned and who provisioned it.
:param str id: The resource instance URL-encoded CRN or GUID.
:param dict headers: A `dict` contai... | def get_resource_instance(self, id: str, **kwargs) -> DetailedResponse:
"""
Get a resource instance.
Retrieve a resource instance by URL-encoded CRN or GUID. Find more details on a
particular instance, like when it was provisioned and who provisioned it.
:param str id: The resource instance URL-enco... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.06128374859690666,
-0.06782019883394241,
-0.00803062692284584,
-0.044455092400312424,
0.016512665897607803,
-0.01856207847595215,
0.039110369980335236,
-0.009822733700275421,
-0.005859333090484142,
-0.01024706196039915,
-0.003624841570854187,
0.01904960349202156,
0.027843117713928223,
-0... |
719,934 | ibm_platform_services.resource_controller_v2 | get_resource_key |
Get resource key.
View the details of a resource key by URL-encoded CRN or GUID, like the
credentials for the key and who created it.
:param str id: The resource key URL-encoded CRN or GUID.
:param dict headers: A `dict` containing the request headers
:return: A `Detai... | def get_resource_key(self, id: str, **kwargs) -> DetailedResponse:
"""
Get resource key.
View the details of a resource key by URL-encoded CRN or GUID, like the
credentials for the key and who created it.
:param str id: The resource key URL-encoded CRN or GUID.
:param dict headers: A `dict` cont... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0030960063450038433,
-0.04989505931735039,
-0.040275003761053085,
-0.0024700744543224573,
0.04124418646097183,
-0.004733748733997345,
0.01655690371990204,
0.001771229668520391,
0.04504913464188576,
-0.0491771437227726,
-0.00782078132033348,
0.02816019579768181,
0.06730448454618454,
-0.0... |
719,935 | ibm_platform_services.resource_controller_v2 | list_reclamations |
Get a list of all reclamations.
View all of the resource reclamations that exist for every resource instance.
:param str account_id: (optional) An alpha-numeric value identifying the
account ID.
:param str resource_instance_id: (optional) The GUID of the resource
... | def list_reclamations(
self, *, account_id: str = None, resource_instance_id: str = None, **kwargs
) -> DetailedResponse:
"""
Get a list of all reclamations.
View all of the resource reclamations that exist for every resource instance.
:param str account_id: (optional) An alpha-numeric value identif... | (self, *, account_id: Optional[str] = None, resource_instance_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.04334736615419388,
-0.051009420305490494,
0.011945356614887714,
-0.04068693146109581,
-0.027171917259693146,
-0.012974058277904987,
-0.013745584525167942,
-0.03749440610408783,
0.045830439776182175,
0.05040638893842697,
-0.010287018492817879,
0.01107628084719181,
0.02043214626610279,
0.0... |
719,936 | ibm_platform_services.resource_controller_v2 | list_resource_aliases |
Get a list of all resource aliases.
View all of the resource aliases that exist for every resource instance.
:param str guid: (optional) The GUID of the alias.
:param str name: (optional) The human-readable name of the alias.
:param str resource_instance_id: (optional) The ID ... | def list_resource_aliases(
self,
*,
guid: str = None,
name: str = None,
resource_instance_id: str = None,
region_instance_id: str = None,
resource_id: str = None,
resource_group_id: str = None,
limit: int = None,
start: str = None,
updated_from: str = None,
updated_to: st... | (self, *, guid: Optional[str] = None, name: Optional[str] = None, resource_instance_id: Optional[str] = None, region_instance_id: Optional[str] = None, resource_id: Optional[str] = None, resource_group_id: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, updated_from: Optional[str] = None... | [
0.0021655485033988953,
-0.06830758601427078,
0.019139323383569717,
-0.04055190086364746,
-0.003765075234696269,
0.054044757038354874,
-0.014675314538180828,
-0.0605345256626606,
0.00018633455329108983,
-0.035473745316267014,
-0.03090890683233738,
-0.0104404641315341,
0.037838663905858994,
... |
719,937 | ibm_platform_services.resource_controller_v2 | list_resource_aliases_for_instance |
Get a list of all resource aliases for the instance.
Retrieving a list of all resource aliases can help you find out who's using the
resource instance.
:param str id: The resource instance URL-encoded CRN or GUID.
:param int limit: (optional) Limit on how many items should be ... | def list_resource_aliases_for_instance(
self, id: str, *, limit: int = None, start: str = None, **kwargs
) -> DetailedResponse:
"""
Get a list of all resource aliases for the instance.
Retrieving a list of all resource aliases can help you find out who's using the
resource instance.
:param str i... | (self, id: str, *, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.018263379111886024,
-0.06809955090284348,
0.03422421216964722,
-0.048667456954717636,
-0.002738634590059519,
0.07521651685237885,
0.005956966429948807,
-0.060354623943567276,
0.022746367380023003,
-0.0031354750972241163,
-0.03900374099612236,
-0.015053768642246723,
0.04479499161243439,
-... |
719,938 | ibm_platform_services.resource_controller_v2 | list_resource_bindings |
Get a list of all resource bindings.
View all of the resource bindings that exist for all of your resource aliases.
:param str guid: (optional) The GUID of the binding.
:param str name: (optional) The human-readable name of the binding.
:param str resource_group_id: (optional)... | def list_resource_bindings(
self,
*,
guid: str = None,
name: str = None,
resource_group_id: str = None,
resource_id: str = None,
region_binding_id: str = None,
limit: int = None,
start: str = None,
updated_from: str = None,
updated_to: str = None,
**kwargs,
) -> DetailedR... | (self, *, guid: Optional[str] = None, name: Optional[str] = None, resource_group_id: Optional[str] = None, resource_id: Optional[str] = None, region_binding_id: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, updated_from: Optional[str] = None, updated_to: Optional[str] = None, **kwargs)... | [
0.0034258596133440733,
-0.08940991759300232,
-0.03417648747563362,
-0.08218413591384888,
-0.01833815686404705,
0.05554363131523132,
0.00022224181157071143,
-0.019013293087482452,
-0.0073215775191783905,
-0.06733114272356033,
-0.05076294019818306,
0.01394064910709858,
0.005693039856851101,
... |
719,939 | ibm_platform_services.resource_controller_v2 | list_resource_bindings_for_alias |
Get a list of all resource bindings for the alias.
View all of the resource bindings associated with a specific resource alias.
:param str id: The resource alias URL-encoded CRN or GUID.
:param int limit: (optional) Limit on how many items should be returned.
:param str start:... | def list_resource_bindings_for_alias(
self, id: str, *, limit: int = None, start: str = None, **kwargs
) -> DetailedResponse:
"""
Get a list of all resource bindings for the alias.
View all of the resource bindings associated with a specific resource alias.
:param str id: The resource alias URL-enco... | (self, id: str, *, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.007273260969668627,
-0.048277586698532104,
0.027617309242486954,
-0.06647830456495285,
0.0018161191837862134,
0.0921279713511467,
-0.02988361567258835,
-0.016197938472032547,
0.00012174257426522672,
-0.06219165027141571,
-0.059732094407081604,
0.018639927729964256,
0.01473977230489254,
... |
719,940 | ibm_platform_services.resource_controller_v2 | list_resource_instances |
Get a list of all resource instances.
View a list of all available resource instances. Resources is a broad term that
could mean anything from a service instance to a virtual machine associated with
the customer account.
:param str guid: (optional) The GUID of the instance.
... | def list_resource_instances(
self,
*,
guid: str = None,
name: str = None,
resource_group_id: str = None,
resource_id: str = None,
resource_plan_id: str = None,
type: str = None,
sub_type: str = None,
limit: int = None,
start: str = None,
state: str = None,
updated_fro... | (self, *, guid: Optional[str] = None, name: Optional[str] = None, resource_group_id: Optional[str] = None, resource_id: Optional[str] = None, resource_plan_id: Optional[str] = None, type: Optional[str] = None, sub_type: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, state: Optional[str]... | [
0.02991349808871746,
-0.08180578052997589,
-0.017778601497411728,
-0.07483962178230286,
-0.038891274482011795,
0.024921705946326256,
0.034141622483730316,
-0.07852759212255478,
-0.054946962743997574,
0.004414382856339216,
-0.009517931379377842,
0.0225189421325922,
0.015254766680300236,
-0.... |
719,941 | ibm_platform_services.resource_controller_v2 | list_resource_keys |
Get a list of all of the resource keys.
View all of the resource keys that exist for all of your resource instances.
:param str guid: (optional) The GUID of the key.
:param str name: (optional) The human-readable name of the key.
:param str resource_group_id: (optional) The ID... | def list_resource_keys(
self,
*,
guid: str = None,
name: str = None,
resource_group_id: str = None,
resource_id: str = None,
limit: int = None,
start: str = None,
updated_from: str = None,
updated_to: str = None,
**kwargs,
) -> DetailedResponse:
"""
Get a list of all ... | (self, *, guid: Optional[str] = None, name: Optional[str] = None, resource_group_id: Optional[str] = None, resource_id: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, updated_from: Optional[str] = None, updated_to: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.... | [
-0.0367964431643486,
-0.07416783273220062,
-0.09860296547412872,
-0.048259396106004715,
0.0073934257961809635,
0.04861873760819435,
0.013780699111521244,
-0.059003669768571854,
0.026339640840888023,
-0.016475750133395195,
-0.026716947555541992,
-0.03178364410996437,
0.060980040580034256,
-... |
719,942 | ibm_platform_services.resource_controller_v2 | list_resource_keys_for_instance |
Get a list of all the resource keys for the instance.
You may have many resource keys for one resource instance. For example, you may
have a different resource key for each user or each role.
:param str id: The resource instance URL-encoded CRN or GUID.
:param int limit: (opti... | def list_resource_keys_for_instance(
self, id: str, *, limit: int = None, start: str = None, **kwargs
) -> DetailedResponse:
"""
Get a list of all the resource keys for the instance.
You may have many resource keys for one resource instance. For example, you may
have a different resource key for eac... | (self, id: str, *, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.0004769674560520798,
-0.08313143253326416,
-0.051834478974342346,
-0.04962652176618576,
0.006856064777821302,
0.06287427991628647,
0.03241845592856407,
-0.04664752632379532,
0.044299378991127014,
0.019801542162895203,
-0.025969810783863068,
-0.022079596295952797,
0.05859854817390442,
-0.... |
719,943 | ibm_platform_services.resource_controller_v2 | lock_resource_instance |
Lock a resource instance.
Locks a resource instance. A locked instance can not be updated or deleted. It
does not affect actions performed on child resources like aliases, bindings, or
keys.
:param str id: The resource instance URL-encoded CRN or GUID.
:param dict head... | def lock_resource_instance(self, id: str, **kwargs) -> DetailedResponse:
"""
Lock a resource instance.
Locks a resource instance. A locked instance can not be updated or deleted. It
does not affect actions performed on child resources like aliases, bindings, or
keys.
:param str id: The resource ... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.07276707887649536,
-0.04727023467421532,
0.00241803377866745,
-0.004038183018565178,
0.01265977043658495,
-0.030248694121837616,
0.024344347417354584,
0.009849443100392818,
-0.0034840963780879974,
0.0025665289722383022,
-0.021135078743100166,
-0.06794431060552597,
0.026365654543042183,
-... |
719,945 | ibm_platform_services.resource_controller_v2 | run_reclamation_action |
Perform a reclamation action.
Reclaim a resource instance so that it can no longer be used, or restore the
resource instance so that it's usable again.
:param str id: The ID associated with the reclamation.
:param str action_name: The reclamation action name. Specify `reclaim`... | def run_reclamation_action(
self, id: str, action_name: str, *, request_by: str = None, comment: str = None, **kwargs
) -> DetailedResponse:
"""
Perform a reclamation action.
Reclaim a resource instance so that it can no longer be used, or restore the
resource instance so that it's usable again.
... | (self, id: str, action_name: str, *, request_by: Optional[str] = None, comment: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.040558818727731705,
-0.00355536094866693,
-0.000535612809471786,
-0.01794302836060524,
0.030843909829854965,
-0.04953495040535927,
-0.029624929651618004,
0.04133453220129013,
0.0250075776129961,
0.005614699795842171,
0.009230086579918861,
0.013307208195328712,
0.06711782515048981,
0.0233... |
719,953 | ibm_platform_services.resource_controller_v2 | unlock_resource_instance |
Unlock a resource instance.
Unlock a resource instance to update or delete it. Unlocking a resource instance
does not affect child resources like aliases, bindings or keys.
:param str id: The resource instance URL-encoded CRN or GUID.
:param dict headers: A `dict` containing t... | def unlock_resource_instance(self, id: str, **kwargs) -> DetailedResponse:
"""
Unlock a resource instance.
Unlock a resource instance to update or delete it. Unlocking a resource instance
does not affect child resources like aliases, bindings or keys.
:param str id: The resource instance URL-encoded... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.08646820485591888,
-0.04160128906369209,
0.012725308537483215,
-0.018670884892344475,
-0.015059169381856918,
-0.051469169557094574,
0.011536193080246449,
0.0089272391051054,
-0.007458592765033245,
0.021475067362189293,
-0.012689812108874321,
-0.05001383274793625,
0.01014297641813755,
-0.... |
719,954 | ibm_platform_services.resource_controller_v2 | update_resource_alias |
Update a resource alias.
Use the resource alias URL-encoded CRN or GUID to update the resource alias.
:param str id: The resource alias URL-encoded CRN or GUID.
:param str name: The new name of the alias. Must be 180 characters or less
and cannot include any special cha... | def update_resource_alias(self, id: str, name: str, **kwargs) -> DetailedResponse:
"""
Update a resource alias.
Use the resource alias URL-encoded CRN or GUID to update the resource alias.
:param str id: The resource alias URL-encoded CRN or GUID.
:param str name: The new name of the alias. Must be ... | (self, id: str, name: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0008950107730925083,
-0.05294124409556389,
0.025440003722906113,
0.004545117728412151,
-0.0017674202099442482,
-0.004088571760803461,
-0.05391761660575867,
-0.015486398711800575,
0.052507296204566956,
-0.035312242805957794,
-0.02144409529864788,
-0.035348404198884964,
0.0488910935819149,
... |
719,955 | ibm_platform_services.resource_controller_v2 | update_resource_binding |
Update a resource binding.
Use the resource binding URL-encoded CRN or GUID to update the resource binding.
:param str id: The resource binding URL-encoded CRN or GUID.
:param str name: The new name of the binding. Must be 180 characters or
less and cannot include any s... | def update_resource_binding(self, id: str, name: str, **kwargs) -> DetailedResponse:
"""
Update a resource binding.
Use the resource binding URL-encoded CRN or GUID to update the resource binding.
:param str id: The resource binding URL-encoded CRN or GUID.
:param str name: The new name of the bindi... | (self, id: str, name: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.020385434851050377,
-0.07902821153402328,
-0.024359025061130524,
-0.05563024431467056,
-0.007637607399374247,
-0.02343493327498436,
-0.017631646245718002,
0.04391277953982353,
0.04735039547085762,
-0.07215297967195511,
-0.03877483680844307,
-0.014933302067220211,
0.026761658489704132,
0.... |
719,956 | ibm_platform_services.resource_controller_v2 | update_resource_instance |
Update a resource instance.
Use the resource instance URL-encoded CRN or GUID to make updates to the resource
instance, like changing the name or plan.
:param str id: The resource instance URL-encoded CRN or GUID.
:param str name: (optional) The new name of the instance. Must ... | def update_resource_instance(
self,
id: str,
*,
name: str = None,
parameters: dict = None,
resource_plan_id: str = None,
allow_cleanup: bool = None,
**kwargs,
) -> DetailedResponse:
"""
Update a resource instance.
Use the resource instance URL-encoded CRN or GUID to make upda... | (self, id: str, *, name: Optional[str] = None, parameters: Optional[dict] = None, resource_plan_id: Optional[str] = None, allow_cleanup: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.09043174237012863,
-0.06242124363780022,
0.0026024538092315197,
-0.03881562128663063,
-0.024000929668545723,
-0.04453819617629051,
0.030608244240283966,
-0.016527699306607246,
0.01520058885216713,
0.021026697009801865,
-0.03772381320595741,
-0.036255523562431335,
0.049168962985277176,
0.... |
719,957 | ibm_platform_services.resource_controller_v2 | update_resource_key |
Update a resource key.
Use the resource key URL-encoded CRN or GUID to update the resource key.
:param str id: The resource key URL-encoded CRN or GUID.
:param str name: The new name of the key. Must be 180 characters or less
and cannot include any special characters ot... | def update_resource_key(self, id: str, name: str, **kwargs) -> DetailedResponse:
"""
Update a resource key.
Use the resource key URL-encoded CRN or GUID to update the resource key.
:param str id: The resource key URL-encoded CRN or GUID.
:param str name: The new name of the key. Must be 180 characte... | (self, id: str, name: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.002604294801130891,
-0.05786490812897682,
-0.08371148258447647,
0.0040046293288469315,
0.01088473666459322,
-0.039611466228961945,
-0.021788176149129868,
0.0047386945225298405,
0.062428269535303116,
-0.03377635031938553,
-0.014344662427902222,
-0.03171909600496292,
0.07840003073215485,
... |
719,958 | ibm_platform_services.resource_manager_v2 | ResourceManagerV2 | The Resource Manager V2 service. | class ResourceManagerV2(BaseService):
"""The Resource Manager V2 service."""
DEFAULT_SERVICE_URL = 'https://resource-controller.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'resource_manager'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'ResourceM... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.0033290788996964693,
-0.02633718214929104,
-0.09716056287288666,
-0.044655028730630875,
0.011870725080370903,
-0.020618129521608353,
-0.023931380361318588,
0.017674190923571587,
0.02927056886255741,
-0.018011845648288727,
0.020385991781949997,
-0.008684094995260239,
0.03140202537178993,
... |
719,959 | ibm_platform_services.resource_manager_v2 | __init__ |
Construct a new client for the Resource Manager 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 authent... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Resource Manager 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.005801933817565441,
-0.06762319058179855,
-0.0023596889805048704,
-0.011622735299170017,
-0.008467049337923527,
-0.043924883008003235,
-0.011000089347362518,
0.042038075625896454,
-0.008646296337246895,
0.004896265920251608,
0.0014811441069468856,
0.029132312163710594,
-0.02277376875281334... |
719,965 | ibm_platform_services.resource_manager_v2 | create_resource_group |
Create a resource group.
Create a resource group in an account to organize your account resources in
customizable groupings so that you can quickly assign users access to more than
one resource at a time. To learn what makes a good resource group strategy, see
[Best practices f... | def create_resource_group(self, *, name: str = None, account_id: str = None, **kwargs) -> DetailedResponse:
"""
Create a resource group.
Create a resource group in an account to organize your account resources in
customizable groupings so that you can quickly assign users access to more than
one res... | (self, *, name: Optional[str] = None, account_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.05999982729554176,
-0.018682019785046577,
-0.08034954965114594,
-0.05569003149867058,
-0.0055793095380067825,
-0.012873167172074318,
-0.03558390587568283,
0.012170483358204365,
-0.00578542985022068,
-0.03348522633314133,
0.06419719010591507,
0.027226654812693596,
0.043884944170713425,
-... |
719,966 | ibm_platform_services.resource_manager_v2 | delete_resource_group |
Delete a resource group.
Delete a resource group by the alias ID. You can delete a resource group only if
the targeted resource group does not contain any resources or if it is not a
default resource group. When a user creates an account, a default resource group
is created in ... | def delete_resource_group(self, id: str, **kwargs) -> DetailedResponse:
"""
Delete a resource group.
Delete a resource group by the alias ID. You can delete a resource group only if
the targeted resource group does not contain any resources or if it is not a
default resource group. When a user creat... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.01909453421831131,
-0.007934799417853355,
-0.030390918254852295,
-0.056336164474487305,
0.0008136357646435499,
-0.015186349861323833,
-0.04565925896167755,
0.06395211070775986,
0.00624034134671092,
0.00680516054853797,
0.022337689995765686,
-0.010303395800292492,
0.0266376044601202,
-0.... |
719,973 | ibm_platform_services.resource_manager_v2 | get_quota_definition |
Get a quota definition.
Call this method to retrieve information about a particular quota by passing the
quota ID. The response can be used to identify the quota type, Standard or Paid.
Information about available resources, such as number of apps, number of service
instances, ... | def get_quota_definition(self, id: str, **kwargs) -> DetailedResponse:
"""
Get a quota definition.
Call this method to retrieve information about a particular quota by passing the
quota ID. The response can be used to identify the quota type, Standard or Paid.
Information about available resources, ... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
0.007115582935512066,
-0.036553509533405304,
-0.0076123313046991825,
-0.047437217086553574,
-0.006887346971780062,
0.014857695437967777,
-0.0038486800622195005,
-0.03687572479248047,
-0.047580424696207047,
-0.02708396688103676,
0.04575454071164131,
0.009183129295706749,
-0.012620090506970882... |
719,974 | ibm_platform_services.resource_manager_v2 | get_resource_group |
Get a resource group.
Retrieve a resource group by alias ID. Call this method to get details about a
particular resource group, like the name of the resource group, associated quotas,
whether the state is active, the resource group ID and the CRN. The `id` returned
in the respo... | def get_resource_group(self, id: str, **kwargs) -> DetailedResponse:
"""
Get a resource group.
Retrieve a resource group by alias ID. Call this method to get details about a
particular resource group, like the name of the resource group, associated quotas,
whether the state is active, the resource g... | (self, id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.01509736105799675,
-0.023522060364484787,
-0.04901982471346855,
-0.04148978367447853,
0.007203863933682442,
0.000815443869214505,
-0.011966056190431118,
0.026746558025479317,
0.012935269623994827,
-0.027454830706119537,
0.020334839820861816,
-0.0021714104805141687,
0.02825629524886608,
... |
719,975 | ibm_platform_services.resource_manager_v2 | list_quota_definitions |
List quota definitions.
Get a list of all quota definitions. Quotas for a resource group limit the number
of apps, instances, and memory allowed for that specific resource group. Each
resource group that you have on your account has a specific set of quotas.
Standard quotas are... | def list_quota_definitions(self, **kwargs) -> DetailedResponse:
"""
List quota definitions.
Get a list of all quota definitions. Quotas for a resource group limit the number
of apps, instances, and memory allowed for that specific resource group. Each
resource group that you have on your account has... | (self, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.005301324184983969,
-0.04177602007985115,
-0.03236319497227669,
-0.0699792429804802,
-0.004931156989187002,
0.040859416127204895,
-0.022862235084176064,
-0.06719417124986649,
-0.04734615609049797,
0.0029150673653930426,
0.05178816244006157,
0.010514513589441776,
-0.03539504110813141,
-0... |
719,976 | ibm_platform_services.resource_manager_v2 | list_resource_groups |
Get a list of all resource groups.
Call this method to retrieve information about all resource groups and associated
quotas in an account. The `id` returned in the response can be used to [create a
resource instance
later](https://cloud.ibm.com/apidocs/resource-controller/resou... | def list_resource_groups(
self,
*,
account_id: str = None,
date: str = None,
name: str = None,
default: bool = None,
include_deleted: bool = None,
**kwargs
) -> DetailedResponse:
"""
Get a list of all resource groups.
Call this method to retrieve information about all resourc... | (self, *, account_id: Optional[str] = None, date: Optional[str] = None, name: Optional[str] = None, default: Optional[bool] = None, include_deleted: Optional[bool] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.015752729028463364,
-0.029645565897226334,
-0.08183528482913971,
-0.07142740488052368,
-0.012775021605193615,
0.019613416865468025,
-0.018721044063568115,
-0.011149964295327663,
0.026019714772701263,
0.005025468301028013,
0.027090560644865036,
-0.01559304166585207,
0.004870477132499218,
... |
719,985 | ibm_platform_services.resource_manager_v2 | update_resource_group |
Update a resource group.
Update a resource group by the alias ID. Call this method to update information
about an existing resource group. You can rename a resource group and activate or
suspend a particular resource group. To update a resource group, users need to be
assigned ... | def update_resource_group(self, id: str, *, name: str = None, state: str = None, **kwargs) -> DetailedResponse:
"""
Update a resource group.
Update a resource group by the alias ID. Call this method to update information
about an existing resource group. You can rename a resource group and activate or
... | (self, id: str, *, name: Optional[str] = None, state: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.018113698810338974,
-0.020870743319392204,
-0.05190397799015045,
-0.042531903833150864,
-0.0017596164252609015,
-0.044075097888708115,
-0.024484073743224144,
0.006525636184960604,
0.028097404167056084,
-0.023825393989682198,
0.0008921584230847657,
-0.038918573409318924,
0.0293959435075521... |
719,986 | ibm_platform_services.usage_metering_v4 | UsageMeteringV4 | The usage_metering V4 service. | class UsageMeteringV4(BaseService):
"""The usage_metering V4 service."""
DEFAULT_SERVICE_URL = 'https://billing.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'usage_metering'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'UsageMeteringV4':
"... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.0471680723130703,
-0.09890954941511154,
-0.0544157549738884,
-0.015735609456896782,
0.014437228441238403,
-0.008274760097265244,
-0.0208516214042902,
-0.0019669511821120977,
-0.04453255236148834,
-0.024378567934036255,
-0.017838213592767715,
-0.0029940293170511723,
0.011656366288661957,
... |
719,987 | ibm_platform_services.usage_metering_v4 | __init__ |
Construct a new client for the usage_metering 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 usage_metering 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.005126168020069599,
-0.08309411257505417,
0.00949954241514206,
0.003604897065088153,
-0.010870702564716339,
-0.017376992851495743,
-0.010960320942103863,
0.018694382160902023,
-0.057104796171188354,
0.004718404728919268,
-0.008240405470132828,
0.035524703562259674,
-0.03781893476843834,
... |
720,000 | ibm_platform_services.usage_metering_v4 | report_resource_usage |
Report Resource Controller resource usage.
Report usage for resource instances that were provisioned through the resource
controller.
:param str resource_id: The resource for which the usage is submitted.
:param List[ResourceInstanceUsage] resource_usage:
:param dict h... | def report_resource_usage(
self, resource_id: str, resource_usage: List['ResourceInstanceUsage'], **kwargs
) -> DetailedResponse:
"""
Report Resource Controller resource usage.
Report usage for resource instances that were provisioned through the resource
controller.
:param str resource_id: The ... | (self, resource_id: str, resource_usage: List[ibm_platform_services.usage_metering_v4.ResourceInstanceUsage], **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.017516471445560455,
-0.0559367798268795,
-0.00907070655375719,
-0.024925196543335915,
-0.01287016924470663,
-0.005062930751591921,
0.01967206783592701,
-0.017742900177836418,
-0.056842491030693054,
-0.061371054500341415,
-0.02193634770810604,
0.01095005962997675,
0.05423404276371002,
-0... |
720,008 | ibm_platform_services.usage_reports_v4 | UsageReportsV4 | The Usage Reports V4 service. | class UsageReportsV4(BaseService):
"""The Usage Reports V4 service."""
DEFAULT_SERVICE_URL = 'https://billing.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'usage_reports'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'UsageReportsV4':
"""
... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.01787051558494568,
-0.05730009078979492,
-0.04164678230881691,
-0.027587417513132095,
-0.002609309973195195,
-0.014958511106669903,
-0.027158280834555626,
-0.026218265295028687,
-0.038561079651117325,
-0.04622425138950348,
0.002955429954454303,
-0.010708005167543888,
0.0457746796309948,
... |
720,009 | ibm_platform_services.usage_reports_v4 | __init__ |
Construct a new client for the 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 authentica... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the Usage Reports 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.028126152232289314,
-0.09076912701129913,
0.006413232069462538,
-0.010669163428246975,
-0.017565306276082993,
-0.028974631801247597,
-0.01549826841801405,
0.022421490401029587,
-0.030725745484232903,
-0.016319667920470238,
-0.009161760099232197,
0.025580717250704765,
-0.043001603335142136... |
720,015 | ibm_platform_services.usage_reports_v4 | create_reports_snapshot_config |
Setup the snapshot configuration.
Snapshots of the billing reports would be taken on a periodic interval and stored
based on the configuration setup by the customer for the given Account Id.
:param str account_id: Account ID for which billing report snapshot is
configur... | def create_reports_snapshot_config(
self,
account_id: str,
interval: str,
cos_bucket: str,
cos_location: str,
*,
cos_reports_folder: Optional[str] = None,
report_types: Optional[List[str]] = None,
versioning: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Setu... | (self, account_id: str, interval: str, cos_bucket: str, cos_location: str, *, cos_reports_folder: Optional[str] = None, report_types: Optional[List[str]] = None, versioning: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.06103556230664253,
-0.08541222661733627,
-0.04417096823453903,
-0.043382201343774796,
-0.04668750986456871,
0.005094122141599655,
-0.05179571732878685,
0.01385037787258625,
-0.11253079771995544,
-0.01477060653269291,
-0.01218833215534687,
0.01748434081673622,
0.008887717500329018,
-0.02... |
720,016 | ibm_platform_services.usage_reports_v4 | delete_reports_snapshot_config |
Delete the snapshot configuration.
Delete the configuration of snapshot of the billing reports setup by the customer
for the given Account Id.
:param str account_id: Account ID for which the billing report snapshot is
configured.
:param dict headers: A `dict` co... | def delete_reports_snapshot_config(
self,
account_id: str,
**kwargs,
) -> DetailedResponse:
"""
Delete the snapshot configuration.
Delete the configuration of snapshot of the billing reports setup by the customer
for the given Account Id.
:param str account_id: Account ID for which the b... | (self, account_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.043259043246507645,
-0.07107359170913696,
0.0033230974804610014,
-0.05367593467235565,
-0.048793017864227295,
-0.005986096803098917,
-0.05172276869416237,
0.05750993266701698,
-0.06832469254732132,
-0.023655029013752937,
-0.02025507017970085,
-0.0062166787683963776,
0.008617447689175606,
... |
720,020 | ibm_platform_services.usage_reports_v4 | get_account_summary |
Get account summary.
Returns the summary for the account for a given month. Account billing managers
are authorized to access this report.
:param str account_id: Account ID for which the usage report is requested.
:param str billingmonth: The billing month for which the usage ... | def get_account_summary(
self,
account_id: str,
billingmonth: str,
**kwargs,
) -> DetailedResponse:
"""
Get account summary.
Returns the summary for the account for a given month. Account billing managers
are authorized to access this report.
:param str account_id: Account ID for whi... | (self, account_id: str, billingmonth: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.0508732795715332,
0.0008598202257417142,
0.0008855563355609775,
-0.013710330240428448,
0.014103391207754612,
-0.013785199262201786,
-0.0037317366804927588,
-0.049750249832868576,
-0.049563080072402954,
-0.03586210682988167,
-0.023714659735560417,
-0.018810760229825974,
0.00275142467580735... |
720,021 | ibm_platform_services.usage_reports_v4 | get_account_usage |
Get account usage.
Usage for all the resources and plans in an account for a given month. Account
billing managers are authorized to access this report.
:param str account_id: Account ID for which the usage report is requested.
:param str billingmonth: The billing month for wh... | def get_account_usage(
self,
account_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
accept_language: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Get account usage.
Usage for all the resources and plans in an account for a given month. Account
bill... | (self, account_id: str, billingmonth: str, *, names: Optional[bool] = None, accept_language: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.019135259091854095,
-0.019301652908325195,
-0.0005794886965304613,
-0.018275558948516846,
-0.019301652908325195,
0.016796505078673363,
-0.0010156939970329404,
-0.03424009680747986,
-0.06474558264017105,
-0.051655955612659454,
0.007769654504954815,
-0.007570907007902861,
0.0298953764140605... |
720,025 | ibm_platform_services.usage_reports_v4 | get_org_usage |
Get organization usage.
Usage for all the resources and plans in an organization in a given month. Account
billing managers or organization billing managers are authorized to access this
report.
:param str account_id: Account ID for which the usage report is requested.
... | def get_org_usage(
self,
account_id: str,
organization_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
accept_language: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Get organization usage.
Usage for all the resources and plans in an organization in ... | (self, account_id: str, organization_id: str, billingmonth: str, *, names: Optional[bool] = None, accept_language: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.006940800230950117,
-0.008229542523622513,
-0.01232590340077877,
-0.024891145527362823,
-0.013651467859745026,
0.009564312174916267,
-0.014314250089228153,
-0.052065204828977585,
-0.07658813893795013,
-0.050076860934495926,
0.015906767919659615,
-0.019386373460292816,
0.026971545070409775... |
720,026 | ibm_platform_services.usage_reports_v4 | get_reports_snapshot |
Fetch the current or past snapshots.
Returns the billing reports snapshots captured for the given Account Id in the
specific time period.
:param str account_id: Account ID for which the billing report snapshot is
requested.
:param str month: The month for which ... | def get_reports_snapshot(
self,
account_id: str,
month: str,
*,
date_from: int = None,
date_to: int = None,
limit: int = None,
start: str = None,
**kwargs,
) -> DetailedResponse:
"""
Fetch the current or past snapshots.
Returns the billing reports snapshots captured for t... | (self, account_id: str, month: str, *, date_from: Optional[int] = None, date_to: Optional[int] = None, limit: Optional[int] = None, start: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.032450832426548004,
-0.0635070875287056,
-0.03854765743017197,
0.008649085648357868,
-0.06676111370325089,
0.020632650703191757,
-0.017235593870282173,
-0.007853459566831589,
-0.08038509637117386,
-0.0030864051077514887,
-0.0275519210845232,
0.015259937383234501,
0.023618485778570175,
-... |
720,027 | ibm_platform_services.usage_reports_v4 | get_reports_snapshot_config |
Fetch the snapshot configuration.
Returns the configuration of snapshot of the billing reports setup by the customer
for the given Account Id.
:param str account_id: Account ID for which the billing report snapshot is
configured.
:param dict headers: A `dict` co... | def get_reports_snapshot_config(
self,
account_id: str,
**kwargs,
) -> DetailedResponse:
"""
Fetch the snapshot configuration.
Returns the configuration of snapshot of the billing reports setup by the customer
for the given Account Id.
:param str account_id: Account ID for which the bill... | (self, account_id: str, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.03116985782980919,
-0.07500635087490082,
-0.024304328486323357,
-0.013385121710598469,
-0.052263177931308746,
-0.008910109288990498,
-0.022423848509788513,
0.0078102052211761475,
-0.06649097055196762,
-0.013562525622546673,
-0.03432764858007431,
-0.0001970846060430631,
-0.0099789667874574... |
720,028 | ibm_platform_services.usage_reports_v4 | get_resource_group_usage |
Get resource group usage.
Usage for all the resources and plans in a resource group in a given month.
Account billing managers or resource group billing managers are authorized to
access this report.
:param str account_id: Account ID for which the usage report is requested.
... | def get_resource_group_usage(
self,
account_id: str,
resource_group_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
accept_language: Optional[str] = None,
**kwargs,
) -> DetailedResponse:
"""
Get resource group usage.
Usage for all the resources and plans in a re... | (self, account_id: str, resource_group_id: str, billingmonth: str, *, names: Optional[bool] = None, accept_language: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.012629983015358448,
-0.02122434973716736,
-0.029762666672468185,
-0.02585783414542675,
-0.03235965967178345,
0.0005896950024180114,
0.013863087631762028,
-0.0022350025828927755,
-0.04958575963973999,
-0.03422800078988075,
0.01743161864578724,
0.002061013365164399,
0.04726902022957802,
-... |
720,029 | ibm_platform_services.usage_reports_v4 | get_resource_usage_account |
Get resource instance usage in an account.
Query for resource instance usage in an account. Filter the results with query
parameters. Account billing administrator is authorized to access this report.
:param str account_id: Account ID for which the usage report is requested.
:... | def get_resource_usage_account(
self,
account_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
tags: Optional[bool] = None,
accept_language: Optional[str] = None,
limit: Optional[int] = None,
start: Optional[str] = None,
resource_group_id: Optional[str] = None,
or... | (self, account_id: str, billingmonth: str, *, names: Optional[bool] = None, tags: Optional[bool] = None, accept_language: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, resource_group_id: Optional[str] = None, organization_id: Optional[str] = None, resource_instance_id: Optional[str] = ... | [
0.022499296814203262,
-0.048260435461997986,
-0.013501430861651897,
-0.028244586661458015,
-0.031228430569171906,
0.022202765569090843,
0.015716148540377617,
-0.05748996511101723,
-0.06134486943483353,
-0.046629514545202255,
0.004390050191432238,
0.007677375338971615,
0.031821493059396744,
... |
720,030 | ibm_platform_services.usage_reports_v4 | get_resource_usage_org |
Get resource instance usage in an organization.
Query for resource instance usage in an organization. Filter the results with
query parameters. Account billing administrator and organization billing
administrators are authorized to access this report.
:param str account_id: Ac... | def get_resource_usage_org(
self,
account_id: str,
organization_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
tags: Optional[bool] = None,
accept_language: Optional[str] = None,
limit: Optional[int] = None,
start: Optional[str] = None,
resource_instance_id: Opt... | (self, account_id: str, organization_id: str, billingmonth: str, *, names: Optional[bool] = None, tags: Optional[bool] = None, accept_language: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, resource_instance_id: Optional[str] = None, resource_id: Optional[str] = None, plan_id: Optional... | [
0.044443659484386444,
-0.040338873863220215,
-0.02946118451654911,
-0.03334207460284233,
-0.02175537683069706,
0.014833211898803711,
0.008050981909036636,
-0.07843876630067825,
-0.06657219678163528,
-0.040450822561979294,
0.003939197398722172,
-0.0055554574355483055,
0.037409547716379166,
... |
720,031 | ibm_platform_services.usage_reports_v4 | get_resource_usage_resource_group |
Get resource instance usage in a resource group.
Query for resource instance usage in a resource group. Filter the results with
query parameters. Account billing administrator and resource group billing
administrators are authorized to access this report.
:param str account_id... | def get_resource_usage_resource_group(
self,
account_id: str,
resource_group_id: str,
billingmonth: str,
*,
names: Optional[bool] = None,
tags: Optional[bool] = None,
accept_language: Optional[str] = None,
limit: Optional[int] = None,
start: Optional[str] = None,
resource_ins... | (self, account_id: str, resource_group_id: str, billingmonth: str, *, names: Optional[bool] = None, tags: Optional[bool] = None, accept_language: Optional[str] = None, limit: Optional[int] = None, start: Optional[str] = None, resource_instance_id: Optional[str] = None, resource_id: Optional[str] = None, plan_id: Option... | [
0.017139721661806107,
-0.03811543434858322,
-0.036159832030534744,
-0.03004857525229454,
-0.03501279652118683,
0.008983545936644077,
0.018747452646493912,
-0.029446851462125778,
-0.05565943941473961,
-0.030593886971473694,
0.0027806214056909084,
0.004475319758057594,
0.04283520206809044,
-... |
720,040 | ibm_platform_services.usage_reports_v4 | update_reports_snapshot_config |
Update the snapshot configuration.
Updates the configuration of snapshot of the billing reports setup by the customer
for the given Account Id.
:param str account_id: Account ID for which billing report snapshot is
configured.
:param str interval: (optional) Fre... | def update_reports_snapshot_config(
self,
account_id: str,
*,
interval: Optional[str] = None,
cos_bucket: Optional[str] = None,
cos_location: Optional[str] = None,
cos_reports_folder: Optional[str] = None,
report_types: Optional[List[str]] = None,
versioning: Optional[str] = None,
... | (self, account_id: str, *, interval: Optional[str] = None, cos_bucket: Optional[str] = None, cos_location: Optional[str] = None, cos_reports_folder: Optional[str] = None, report_types: Optional[List[str]] = None, versioning: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.024619854986667633,
-0.0908174067735672,
-0.04585941135883331,
-0.014779425226151943,
-0.05536181107163429,
-0.014807594008743763,
-0.04875144734978676,
0.017624512314796448,
-0.09404747188091278,
0.00033040091511793435,
-0.030779514461755753,
-0.02792503871023655,
0.01639445684850216,
... |
720,041 | ibm_platform_services.usage_reports_v4 | validate_reports_snapshot_config |
Verify billing to COS authorization.
Verify billing service to COS bucket authorization for the given account_id. If
COS bucket information is not provided, COS bucket information is retrieved from
the configuration file.
:param str account_id: Account ID for which billing rep... | def validate_reports_snapshot_config(
self,
account_id: str,
*,
interval: str = None,
cos_bucket: str = None,
cos_location: str = None,
cos_reports_folder: str = None,
report_types: List[str] = None,
versioning: str = None,
**kwargs,
) -> DetailedResponse:
"""
Verify bill... | (self, account_id: str, *, interval: Optional[str] = None, cos_bucket: Optional[str] = None, cos_location: Optional[str] = None, cos_reports_folder: Optional[str] = None, report_types: Optional[List[str]] = None, versioning: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.028032558038830757,
-0.0691482350230217,
-0.04467865824699402,
-0.020246783271431923,
-0.04460325092077255,
-0.00922793336212635,
-0.024808907881379128,
0.022904882207512856,
-0.09938644617795944,
-0.0016778061399236321,
-0.006107968278229237,
0.02818337269127369,
0.027862893417477608,
... |
720,042 | ibm_platform_services.user_management_v1 | UserManagementV1 | The User Management V1 service. | class UserManagementV1(BaseService):
"""The User Management V1 service."""
DEFAULT_SERVICE_URL = 'https://user-management.cloud.ibm.com'
DEFAULT_SERVICE_NAME = 'user_management'
@classmethod
def new_instance(
cls,
service_name: str = DEFAULT_SERVICE_NAME,
) -> 'UserManagementV1... | (authenticator: ibm_cloud_sdk_core.authenticators.authenticator.Authenticator = None) -> None | [
0.00212968816049397,
-0.06691092997789383,
-0.018298722803592682,
-0.036000028252601624,
0.009431475773453712,
-0.027149375528097153,
-0.03436265513300896,
-0.05810452997684479,
-0.06332641839981079,
0.0038749261293560266,
-0.0034572859294712543,
-0.05708670616149902,
0.02338784746825695,
... |
720,043 | ibm_platform_services.user_management_v1 | __init__ |
Construct a new client for the User 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 authenti... | def __init__(
self,
authenticator: Authenticator = None,
) -> None:
"""
Construct a new client for the User Management service.
:param Authenticator authenticator: The authenticator specifies the authentication mechanism.
Get up to date information from https://github.com/IBM/python-sdk-c... | (self, authenticator: Optional[ibm_cloud_sdk_core.authenticators.authenticator.Authenticator] = None) -> NoneType | [
-0.02048785611987114,
-0.0619632713496685,
0.0205063633620739,
-0.0039930036291480064,
0.0037732264026999474,
-0.049489185214042664,
0.00018623220967128873,
0.024855637922883034,
-0.020820992067456245,
0.016638286411762238,
-0.006611821707338095,
0.009355565533041954,
-0.04301154240965843,
... |
720,048 | ibm_platform_services.user_management_v1 | accept |
Accept an invitation.
Accept a user invitation to an account. You can use the user's token for
authorization. To use this method, the requesting user must provide the account ID
for the account that they are accepting an invitation for. If the user already
accepted the invitati... | def accept(
self,
*,
account_id: str = None,
**kwargs,
) -> DetailedResponse:
"""
Accept an invitation.
Accept a user invitation to an account. You can use the user's token for
authorization. To use this method, the requesting user must provide the account ID
for the account that the... | (self, *, account_id: Optional[str] = None, **kwargs) -> ibm_cloud_sdk_core.detailed_response.DetailedResponse | [
-0.014652092941105366,
-0.07631711661815643,
0.03651752322912216,
-0.049375299364328384,
-0.007014971226453781,
-0.03035012073814869,
0.023858115077018738,
-0.02317284792661667,
-0.04519156366586685,
0.031233754009008408,
0.04324396327137947,
-0.06690371036529541,
0.0022417702712118626,
-0... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.