Class PrincipalAccessBoundaryPoliciesAsyncClient (2.19.0)
Stay organized with collections Save and categorize content based on your preferences.

PrincipalAccessBoundaryPoliciesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.iam_v3beta.services.principal_access_boundary_policies.transports.base.PrincipalAccessBoundaryPoliciesTransport, typing.Callable[[...], google.cloud.iam_v3beta.services.principal_access_boundary_policies.transports.base.PrincipalAccessBoundaryPoliciesTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Manages Identity and Access Management (IAM) principal access boundary policies.

Properties

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type	Description
`str`	The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type	Description
`PrincipalAccessBoundaryPoliciesTransport`	The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type	Description
`str`	The universe domain used by the client instance.

Methods

PrincipalAccessBoundaryPoliciesAsyncClient

PrincipalAccessBoundaryPoliciesAsyncClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.iam_v3beta.services.principal_access_boundary_policies.transports.base.PrincipalAccessBoundaryPoliciesTransport, typing.Callable[[...], google.cloud.iam_v3beta.services.principal_access_boundary_policies.transports.base.PrincipalAccessBoundaryPoliciesTransport]]] = 'grpc_asyncio', client_options: typing.Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the principal access boundary policies async client.

Parameters
Name	Description
`credentials`	`Optional[google.auth.credentials.Credentials]` The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment.
`transport`	`Optional[Union[str,PrincipalAccessBoundaryPoliciesTransport,Callable[..., PrincipalAccessBoundaryPoliciesTransport]]]` The transport to use, or a Callable that constructs and returns a new transport to use. If a Callable is given, it will be called with the same set of initialization arguments as used in the PrincipalAccessBoundaryPoliciesTransport constructor. If set to None, a transport is chosen automatically.
`client_options`	`Optional[Union[google.api_core.client_options.ClientOptions, dict]]` Custom options for the client. 1. The `api_endpoint` property can be used to override the default endpoint provided by the client when `transport` is not explicitly provided. Only if this property is not set and `transport` was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The `universe_domain` property can be used to override the default "googleapis.com" universe. Note that `api_endpoint` property still takes precedence; and `universe_domain` is currently not supported for mTLS.
`client_info`	`google.api_core.gapic_v1.client_info.ClientInfo` The client info used to send a user-agent string along with API requests. If `None`, then default info will be used. Generally, you only need to set this if you're developing your own client library.

Exceptions
Type	Description
`google.auth.exceptions.MutualTlsChannelError`	If mutual TLS transport creation failed for any reason.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> str

Returns a fully-qualified project string.

create_principal_access_boundary_policy

create_principal_access_boundary_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.CreatePrincipalAccessBoundaryPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    principal_access_boundary_policy: typing.Optional[
        google.cloud.iam_v3beta.types.principal_access_boundary_policy_resources.PrincipalAccessBoundaryPolicy
    ] = None,
    principal_access_boundary_policy_id: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Creates a principal access boundary policy, and returns a long running operation.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_create_principal_access_boundary_policy():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.CreatePrincipalAccessBoundaryPolicyRequest(
        parent="parent_value",
        principal_access_boundary_policy_id="principal_access_boundary_policy_id_value",
    )

    # Make the request
    operation = client.create_principal_access_boundary_policy(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.CreatePrincipalAccessBoundaryPolicyRequest, dict]]` The request object. Request message for CreatePrincipalAccessBoundaryPolicyRequest method.
`parent`	`str` Required. The parent resource where this principal access boundary policy will be created. Only organizations are supported. Format: `organizations/{organization_id}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`principal_access_boundary_policy`	`PrincipalAccessBoundaryPolicy` Required. The principal access boundary policy to create. This corresponds to the `principal_access_boundary_policy` field on the `request` instance; if `request` is provided, this should not be set.
`principal_access_boundary_policy_id`	`str` Required. The ID to use for the principal access boundary policy, which will become the final component of the principal access boundary policy's resource name. This value must start with a lowercase letter followed by up to 62 lowercase letters, numbers, hyphens, or dots. Pattern, /`a-z][a-z0-9-.]`{2,62}/. This corresponds to the `principal_access_boundary_policy_id` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be PrincipalAccessBoundaryPolicy An IAM principal access boundary policy resource.

delete_principal_access_boundary_policy

delete_principal_access_boundary_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.DeletePrincipalAccessBoundaryPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Deletes a principal access boundary policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_delete_principal_access_boundary_policy():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.DeletePrincipalAccessBoundaryPolicyRequest(
        name="name_value",
    )

    # Make the request
    operation = client.delete_principal_access_boundary_policy(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.DeletePrincipalAccessBoundaryPolicyRequest, dict]]` The request object. Request message for DeletePrincipalAccessBoundaryPolicy method.
`name`	`str` Required. The name of the principal access boundary policy to delete. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns

Type Description

google.api_core.operation_async.AsyncOperation An object representing a long-running operation. The result type for the operation will be google.protobuf.empty_pb2.Empty A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }

from_service_account_file

from_service_account_file(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`PrincipalAccessBoundaryPoliciesAsyncClient`	The constructed client.

from_service_account_info

from_service_account_info(info: dict, *args, **kwargs)

Creates an instance of this client using the provided credentials info.

Parameter
Name	Description
`info`	`dict` The service account private key info.

Returns
Type	Description
`PrincipalAccessBoundaryPoliciesAsyncClient`	The constructed client.

from_service_account_json

from_service_account_json(filename: str, *args, **kwargs)

Creates an instance of this client using the provided credentials file.

Parameter
Name	Description
`filename`	`str` The path to the service account private key json file.

Returns
Type	Description
`PrincipalAccessBoundaryPoliciesAsyncClient`	The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name	Description
`client_options`	`google.api_core.client_options.ClientOptions` Custom options for the client. Only the `api_endpoint` and `client_cert_source` properties may be used in this method.

Exceptions
Type	Description
`google.auth.exceptions.MutualTLSChannelError`	If any errors happen.

Returns
Type	Description
`Tuple[str, Callable[[], Tuple[bytes, bytes]]]`	returns the API endpoint and the client cert source to use.

get_operation

get_operation(
    request: typing.Optional[
        google.longrunning.operations_pb2.GetOperationRequest
    ] = None,
    *,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.longrunning.operations_pb2.Operation

Gets the latest state of a long-running operation.

Parameters
Name	Description
`request`	`.operations_pb2.GetOperationRequest` The request object. Request message for `GetOperation` method.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`.operations_pb2.Operation`	An `Operation` object.

get_principal_access_boundary_policy

get_principal_access_boundary_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.GetPrincipalAccessBoundaryPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.iam_v3beta.types.principal_access_boundary_policy_resources.PrincipalAccessBoundaryPolicy
)

Gets a principal access boundary policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_get_principal_access_boundary_policy():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.GetPrincipalAccessBoundaryPolicyRequest(
        name="name_value",
    )

    # Make the request
    response = await client.get_principal_access_boundary_policy(request=request)

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.GetPrincipalAccessBoundaryPolicyRequest, dict]]` The request object. Request message for GetPrincipalAccessBoundaryPolicy method.
`name`	`str` Required. The name of the principal access boundary policy to retrieve. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.iam_v3beta.types.PrincipalAccessBoundaryPolicy`	An IAM principal access boundary policy resource.

get_transport_class

get_transport_class(
    label: typing.Optional[str] = None,
) -> typing.Type[
    google.cloud.iam_v3beta.services.principal_access_boundary_policies.transports.base.PrincipalAccessBoundaryPoliciesTransport
]

Returns an appropriate transport class.

Parameter
Name	Description
`label`	`typing.Optional[str]` The name of the desired transport. If none is provided, then the first transport in the registry is used.

list_principal_access_boundary_policies

list_principal_access_boundary_policies(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.ListPrincipalAccessBoundaryPoliciesRequest,
            dict,
        ]
    ] = None,
    *,
    parent: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.iam_v3beta.services.principal_access_boundary_policies.pagers.ListPrincipalAccessBoundaryPoliciesAsyncPager
)

Lists principal access boundary policies.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_list_principal_access_boundary_policies():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.ListPrincipalAccessBoundaryPoliciesRequest(
        parent="parent_value",
    )

    # Make the request
    page_result = client.list_principal_access_boundary_policies(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.ListPrincipalAccessBoundaryPoliciesRequest, dict]]` The request object. Request message for ListPrincipalAccessBoundaryPolicies method.
`parent`	`str` Required. The parent resource, which owns the collection of principal access boundary policies. Format: `organizations/{organization_id}/locations/{location}` This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.iam_v3beta.services.principal_access_boundary_policies.pagers.ListPrincipalAccessBoundaryPoliciesAsyncPager`	Response message for ListPrincipalAccessBoundaryPolicies method. Iterating over this object will yield results and resolve additional pages automatically.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_policy_binding_path

parse_policy_binding_path(path: str) -> typing.Dict[str, str]

Parses a policy_binding path into its component segments.

parse_principal_access_boundary_policy_path

parse_principal_access_boundary_policy_path(path: str) -> typing.Dict[str, str]

Parses a principal_access_boundary_policy path into its component segments.

policy_binding_path

policy_binding_path(organization: str, location: str, policy_binding: str) -> str

Returns a fully-qualified policy_binding string.

principal_access_boundary_policy_path

principal_access_boundary_policy_path(
    organization: str, location: str, principal_access_boundary_policy: str
) -> str

Returns a fully-qualified principal_access_boundary_policy string.

search_principal_access_boundary_policy_bindings

search_principal_access_boundary_policy_bindings(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.SearchPrincipalAccessBoundaryPolicyBindingsRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.iam_v3beta.services.principal_access_boundary_policies.pagers.SearchPrincipalAccessBoundaryPolicyBindingsAsyncPager
)

Returns all policy bindings that bind a specific policy if a user has searchPolicyBindings permission on that policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_search_principal_access_boundary_policy_bindings():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.SearchPrincipalAccessBoundaryPolicyBindingsRequest(
        name="name_value",
    )

    # Make the request
    page_result = client.search_principal_access_boundary_policy_bindings(request=request)

    # Handle the response
    async for response in page_result:
        print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.SearchPrincipalAccessBoundaryPolicyBindingsRequest, dict]]` The request object. Request message for SearchPrincipalAccessBoundaryPolicyBindings rpc.
`name`	`str` Required. The name of the principal access boundary policy. Format: `organizations/{organization_id}/locations/{location}/principalAccessBoundaryPolicies/{principal_access_boundary_policy_id}` This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.cloud.iam_v3beta.services.principal_access_boundary_policies.pagers.SearchPrincipalAccessBoundaryPolicyBindingsAsyncPager`	Response message for SearchPrincipalAccessBoundaryPolicyBindings rpc. Iterating over this object will yield results and resolve additional pages automatically.

update_principal_access_boundary_policy

update_principal_access_boundary_policy(
    request: typing.Optional[
        typing.Union[
            google.cloud.iam_v3beta.types.principal_access_boundary_policies_service.UpdatePrincipalAccessBoundaryPolicyRequest,
            dict,
        ]
    ] = None,
    *,
    principal_access_boundary_policy: typing.Optional[
        google.cloud.iam_v3beta.types.principal_access_boundary_policy_resources.PrincipalAccessBoundaryPolicy
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary_async.AsyncRetry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> google.api_core.operation_async.AsyncOperation

Updates a principal access boundary policy.

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import iam_v3beta

async def sample_update_principal_access_boundary_policy():
    # Create a client
    client = iam_v3beta.PrincipalAccessBoundaryPoliciesAsyncClient()

    # Initialize request argument(s)
    request = iam_v3beta.UpdatePrincipalAccessBoundaryPolicyRequest(
    )

    # Make the request
    operation = client.update_principal_access_boundary_policy(request=request)

    print("Waiting for operation to complete...")

    response = (await operation).result()

    # Handle the response
    print(response)

Parameters
Name	Description
`request`	`Optional[Union[google.cloud.iam_v3beta.types.UpdatePrincipalAccessBoundaryPolicyRequest, dict]]` The request object. Request message for UpdatePrincipalAccessBoundaryPolicy method.
`principal_access_boundary_policy`	`PrincipalAccessBoundaryPolicy` Required. The principal access boundary policy to update. The principal access boundary policy's `name` field is used to identify the policy to update. This corresponds to the `principal_access_boundary_policy` field on the `request` instance; if `request` is provided, this should not be set.
`update_mask`	`google.protobuf.field_mask_pb2.FieldMask` Optional. The list of fields to update This corresponds to the `update_mask` field on the `request` instance; if `request` is provided, this should not be set.
`retry`	`google.api_core.retry_async.AsyncRetry` Designation of what errors, if any, should be retried.
`timeout`	`float` The timeout for this request.
`metadata`	`Sequence[Tuple[str, Union[str, bytes]]]` Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type `str`, but for metadata keys ending with the suffix `-bin`, the corresponding values must be of type `bytes`.

Returns
Type	Description
`google.api_core.operation_async.AsyncOperation`	An object representing a long-running operation. The result type for the operation will be PrincipalAccessBoundaryPolicy An IAM principal access boundary policy resource.

Class PrincipalAccessBoundaryPoliciesAsyncClient (2.19.0) Stay organized with collections Save and categorize content based on your preferences.