cloud_to_cloud_ir¶

The following methods allow for interaction with the ZIA Cloud-to-Cloud DLP Incident Receiver.

Methods are accessible via zia.cloud_to_cloud_ir

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class CloudToCloudIRAPI¶

Bases: APIClient

A Client object for the Cloud-to-Cloud Incident Forwarding resource.

c2c_validate_delete(receiver_id)¶

Validates the specified cloud storage configuration e.g. Amazon S3 bucket configuration of a Cloud-to-Cloud DLP Incident Receiver by verifying he configuration’s current association status with policy rules. Configurations cannot be deleted while being associated with policy rules.

Parameters:: receiver_id (int) – System-generated unique ID of a Cloud-to-Cloud Incident Receiver’s storage
Returns:: Response code for the operation.
Return type:: int

Examples

>>> _, _, err = client.zia.cloud_to_cloud_ir.c2c_validate_delete('123454')
>>> if err:
...     print(f"Error validating c2c deletion: {err}")
...     return
... print(f"C2C Deletion with ID {'123454'} validated successfully.")

get_cloud_to_cloud_ir(receiver_id)¶

Retrieves information about a DLP Incident Receiver configured for Cloud-to-Cloud DLP Incident Forwarding based on the specified ID

Parameters:: receiver_id (str) – System-generated unique ID of the Cloud-to-Cloud Incident Receiver.
Returns:: The ZIA DLP Incident Receiver resource record.
Return type:: Tuple

Examples

>>> fetched_receiver, _, error = client.zia.cloud_to_cloud_ir.get_cloud_to_cloud_ir('5865456')
>>> if error:
...     print(f"Error fetching c2c receiver by ID: {error}")
...     return
... print(f"Fetched c2c receiver by ID: {fetched_receiver.as_dict()}")

list_c2c_count(query_params=None)¶

Retrieves the number of DLP Incident Receivers configured for Cloud-to-Cloud Incident Forwarding

Parameters:

{dict} (query_params) –

Map of query parameters for the request. [query_params.search] {str}: The search string used to match against the names of

Cloud-to-Cloud Incident Forwarding tenants and their configurations

Returns:

A list of c2c receiver resource records.

Return type:

Tuple

Examples

Gets the list of c2c receiver for your organization:

>>> count, _, error = client.zia.cloud_to_cloud_ir.list_c2c_count()
>>> if error:
...     print(f"Error fetching c2c receivers count: {error}")
...     return
... print(f"Total c2c receivers found: {count}")

list_cloud_to_cloud_ir(query_params=None)¶

Retrieves the list of DLP Incident Receivers configured for Cloud-to-Cloud Incident Forwarding.

Parameters:

query_params (dict) –

Map of query parameters for the request.

[query_params.page] (int): Specifies the page offset.

[query_params.page_size] (int): Specifies the page size.: The default size is 50.
[query_params.search] (str): The search string used to match against the names of Cloud-to-Cloud Incident: Forwarding tenants and their configurations

Returns:

A tuple containing (Retries the Cloud-to-Cloud Incident Forwarding instances, Response, error)

Return type:

tuple

Examples

List the Cloud-to-Cloud Incident Forwarding:

>>> c2c_list, response, error = client.zia.cloud_to_cloud_ir.list_cloud_to_cloud_ir()
... if error:
...    print(f"Error listing c2c incident receiver: {error}")
...    return
... print(f"Total c2c incident receiver found: {len(c2c_list)}")
... for c2c in c2c_list:
...    print(c2c.as_dict())

list_cloud_to_cloud_ir_lite(query_params=None)¶

Retrieves the list of DLP Incident Receivers configured for Cloud-to-Cloud DLP Incident Forwarding, with a subset of information for each Incident Receiver

Parameters:

query_params (dict) –

Map of query parameters for the request.

[query_params.page] (int): Specifies the page offset.

[query_params.page_size] (int): Specifies the page size.: The default size is 50.
[query_params.search] (str): The search string used to match against the names of Cloud-to-Cloud Incident: Forwarding tenants and their configurations

Returns:

The ZIA DLP Incident Receiver resource record.

Return type:

Tuple

Examples

List the Cloud-to-Cloud Incident Forwarding:

>>> c2c_list, response, error = client.zia.cloud_to_cloud_ir.list_cloud_to_cloud_ir_lite()
... if error:
...    print(f"Error listing c2c incident receiver: {error}")
...    return
... print(f"Total c2c incident receiver found: {len(c2c_list)}")
... for c2c in c2c_list:
...    print(c2c.as_dict())