Method: googleapis.aiplatform.v1beta1.projects.locations.endpoints.getIamPolicy

Preview

This feature is subject to the "Pre-GA Offerings Terms" in the General Service Terms section of the Service Specific Terms. Pre-GA features are available "as is" and might have limited support. For more information, see the launch stage descriptions.

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

Arguments

Parameters
resource	string REQUIRED: The resource for which the policy is being requested. See Resource names for the appropriate value for this field.
options.requestedPolicyVersion	integer (int32 format) Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the IAM documentation.
region	string Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.

Raised exceptions

Exceptions
ConnectionError	In case of a network problem (such as DNS failure or refused connection).
HttpError	If the response status is >= 400 (excluding 429 and 503).
TimeoutError	If a long-running operation takes longer to finish than the specified timeout limit.
TypeError	If an operation or function receives an argument of the wrong type.
ValueError	If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.

Response

If successful, the response contains an instance of GoogleIamV1Policy.

Subworkflow snippet

Some fields might be optional or required. To identify required fields, refer to the API documentation.

YAML

- getIamPolicy:
    call: googleapis.aiplatform.v1beta1.projects.locations.endpoints.getIamPolicy
    args:
        resource: ...
        options:
            requestedPolicyVersion: ...
        region: ...
    result: getIamPolicyResult

JSON

[
  {
    "getIamPolicy": {
      "call": "googleapis.aiplatform.v1beta1.projects.locations.endpoints.getIamPolicy",
      "args": {
        "resource": "...",
        "options": {
          "requestedPolicyVersion": "..."
        },
        "region": "..."
      },
      "result": "getIamPolicyResult"
    }
  }
]