Class AccessApprovalAsyncClient (1.6.0)

AccessApprovalAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport] = 'grpc_asyncio', client_options: 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>)

This API allows a customer to manage accesses to cloud resources by Google personnel. It defines the following resource model:

The API has a collection of ApprovalRequest resources, named approvalRequests/{approval_request}
The API has top-level settings per Project/Folder/Organization, named accessApprovalSettings

The service also periodically emails a list of recipients, defined at the Project/Folder/Organization level in the accessApprovalSettings, when there is a pending ApprovalRequest for them to act on. The ApprovalRequests can also optionally be published to a Pub/Sub topic owned by the customer (contact support if you would like to enable Pub/Sub notifications).

ApprovalRequests can be approved or dismissed. Google personnel can only access the indicated resource or resources if the request is approved (subject to some exclusions: https://cloud.google.com/access-approval/docs/overview#exclusions).

Note: Using Access Approval functionality will mean that Google may not be able to meet the SLAs for your chosen products, as any support response times may be dramatically increased. As such the SLAs do not apply to any service disruption to the extent impacted by Customer's use of Access Approval. Do not enable Access Approval for projects where you may require high service availability and rapid response by Google Cloud Support.

After a request is approved or dismissed, no further action may be taken on it. Requests with the requested_expiration in the past or with no activity for 14 days are considered dismissed. When an approval expires, the request is considered dismissed.

If a request is not approved or dismissed, we call it pending.

Inheritance

builtins.object > AccessApprovalAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
AccessApprovalTransport	The transport used by the client instance.

Methods

AccessApprovalAsyncClient

AccessApprovalAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.accessapproval_v1.services.access_approval.transports.base.AccessApprovalTransport] = 'grpc_asyncio', client_options: 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 access approval 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	Union[str, `.AccessApprovalTransport`] The transport to use. If set to None, a transport is chosen automatically.
client_options	`ClientOptions` Custom options for the client. It won't take effect if a `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.

Exceptions

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

access_approval_service_account_path

access_approval_service_account_path(project: str)

Returns a fully-qualified access_approval_service_account string.

access_approval_settings_path

access_approval_settings_path(project: str)

Returns a fully-qualified access_approval_settings string.

approval_request_path

approval_request_path(project: str, approval_request: str)

Returns a fully-qualified approval_request string.

approve_approval_request

approve_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.ApproveApprovalRequestMessage, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Approves a request and returns the updated ApprovalRequest.

Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

from google.cloud import accessapproval_v1

async def sample_approve_approval_request():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.ApproveApprovalRequestMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.ApproveApprovalRequestMessage, dict]` The request object. Request to approve an ApprovalRequest.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.ApprovalRequest	A request for the customer to approve access to a resource.

common_billing_account_path

common_billing_account_path(billing_account: str)

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str)

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str)

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str)

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str)

Returns a fully-qualified project string.

delete_access_approval_settings

delete_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.DeleteAccessApprovalSettingsMessage, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Deletes the settings associated with a project, folder, or organization. This will have the effect of disabling Access Approval for the project, folder, or organization, but only if all ancestors also have Access Approval disabled. If Access Approval is enabled at a higher level of the hierarchy, then Access Approval will still be enabled at this level as the settings are inherited.

from google.cloud import accessapproval_v1

async def sample_delete_access_approval_settings():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.DeleteAccessApprovalSettingsMessage(
    )

    # Make the request
    await client.delete_access_approval_settings(request=request)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.DeleteAccessApprovalSettingsMessage, dict]` The request object. Request to delete access approval settings.
name	`str` Name of the AccessApprovalSettings to delete. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

dismiss_approval_request

dismiss_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.DismissApprovalRequestMessage, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Dismisses a request. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether.

Returns NOT_FOUND if the request does not exist.

Returns FAILED_PRECONDITION if the request exists but is not in a pending state.

from google.cloud import accessapproval_v1

async def sample_dismiss_approval_request():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.DismissApprovalRequestMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.DismissApprovalRequestMessage, dict]` The request object. Request to dismiss an approval request.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.ApprovalRequest	A request for the customer to approve access to a resource.

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
AccessApprovalAsyncClient	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
AccessApprovalAsyncClient	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
AccessApprovalAsyncClient	The constructed client.

get_access_approval_service_account

get_access_approval_service_account(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.GetAccessApprovalServiceAccountMessage, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Retrieves the service account that is used by Access Approval to access KMS keys for signing approved approval requests.

from google.cloud import accessapproval_v1

async def sample_get_access_approval_service_account():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.GetAccessApprovalServiceAccountMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.GetAccessApprovalServiceAccountMessage, dict]` The request object. Request to get an Access Approval service account.
name	`str` Name of the AccessApprovalServiceAccount to retrieve. This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.AccessApprovalServiceAccount	Access Approval service account related to a project/folder/organization.

get_access_approval_settings

get_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.GetAccessApprovalSettingsMessage, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets the settings associated with a project, folder, or organization.

from google.cloud import accessapproval_v1

async def sample_get_access_approval_settings():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.GetAccessApprovalSettingsMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.GetAccessApprovalSettingsMessage, dict]` The request object. Request to get access approval settings.
name	`str` The name of the AccessApprovalSettings to retrieve. Format: "{projects\|folders\|organizations}/{id}/accessApprovalSettings" This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.AccessApprovalSettings	Settings on a Project/Folder/Organization related to Access Approval.

get_approval_request

get_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.GetApprovalRequestMessage, dict]] = None, *, name: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Gets an approval request. Returns NOT_FOUND if the request does not exist.

from google.cloud import accessapproval_v1

async def sample_get_approval_request():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.GetApprovalRequestMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.GetApprovalRequestMessage, dict]` The request object. Request to get an approval request.
name	`str` The name of the approval request to retrieve. Format: "{projects\|folders\|organizations}/{id}/approvalRequests/{approval_request}" This corresponds to the `name` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.ApprovalRequest	A request for the customer to approve access to a resource.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: 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 variabel 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_transport_class

get_transport_class()

Returns an appropriate transport class.

invalidate_approval_request

invalidate_approval_request(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.InvalidateApprovalRequestMessage, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest.

NOTE: This does not deny access to the resource if another request has been made and approved. It only invalidates a single approval.

Returns FAILED_PRECONDITION if the request exists but is not in an approved state.

from google.cloud import accessapproval_v1

async def sample_invalidate_approval_request():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.InvalidateApprovalRequestMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.InvalidateApprovalRequestMessage, dict]` The request object. Request to invalidate an existing approval.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.ApprovalRequest	A request for the customer to approve access to a resource.

list_approval_requests

list_approval_requests(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.ListApprovalRequestsMessage, dict]] = None, *, parent: Optional[str] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.

from google.cloud import accessapproval_v1

async def sample_list_approval_requests():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.ListApprovalRequestsMessage(
    )

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

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

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.ListApprovalRequestsMessage, dict]` The request object. Request to list approval requests.
parent	`str` The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}". This corresponds to the `parent` field on the `request` instance; if `request` is provided, this should not be set.
retry	`google.api_core.retry.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.services.access_approval.pagers.ListApprovalRequestsAsyncPager	Response to listing of ApprovalRequest objects. Iterating over this object will yield results and resolve additional pages automatically.

parse_access_approval_service_account_path

parse_access_approval_service_account_path(path: str)

Parses a access_approval_service_account path into its component segments.

parse_access_approval_settings_path

parse_access_approval_settings_path(path: str)

Parses a access_approval_settings path into its component segments.

parse_approval_request_path

parse_approval_request_path(path: str)

Parses a approval_request path into its component segments.

parse_common_billing_account_path

parse_common_billing_account_path(path: str)

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str)

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str)

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str)

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str)

Parse a project path into its component segments.

update_access_approval_settings

update_access_approval_settings(request: Optional[Union[google.cloud.accessapproval_v1.types.accessapproval.UpdateAccessApprovalSettingsMessage, dict]] = None, *, settings: Optional[google.cloud.accessapproval_v1.types.accessapproval.AccessApprovalSettings] = None, update_mask: Optional[google.protobuf.field_mask_pb2.FieldMask] = None, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Updates the settings associated with a project, folder, or organization. Settings to update are determined by the value of field_mask.

from google.cloud import accessapproval_v1

async def sample_update_access_approval_settings():
    # Create a client
    client = accessapproval_v1.AccessApprovalAsyncClient()

    # Initialize request argument(s)
    request = accessapproval_v1.UpdateAccessApprovalSettingsMessage(
    )

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

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.accessapproval_v1.types.UpdateAccessApprovalSettingsMessage, dict]` The request object. Request to update access approval settings.
settings	`AccessApprovalSettings` The new AccessApprovalSettings. This corresponds to the `settings` field on the `request` instance; if `request` is provided, this should not be set.
update_mask	`google.protobuf.field_mask_pb2.FieldMask` The update mask applies to the settings. Only the top level fields of AccessApprovalSettings (notification_emails & enrolled_services) are supported. For each field, if it is included, the currently stored value will be entirely overwritten with the value of the field passed in this request. For the `FieldMask` definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask If this field is left unset, only the notification_emails field will be updated. 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.Retry` Designation of what errors, if any, should be retried.
timeout	`float` The timeout for this request.
metadata	`Sequence[Tuple[str, str]]` Strings which should be sent along with the request as metadata.

Returns

Type	Description
google.cloud.accessapproval_v1.types.AccessApprovalSettings	Settings on a Project/Folder/Organization related to Access Approval.