data_deletion_requests

Creates, updates, deletes, gets or lists a data_deletion_requests resource.

Overview

Name	data_deletion_requests
Type	Resource
Id	datadog.organization.data_deletion_requests

Fields

The following fields are returned by SELECT queries:

get_data_deletion_requests

Name	Datatype	Description
id	string	The ID of the created data deletion request. (example: 1)
attributes	object	Deletion attribute for data deletion response.
type	string	The type of the request created. (example: deletion_request)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_data_deletion_requests	select		next_page, product, query, status, page_size	Gets a list of data deletion requests based on several filter parameters.
create_data_deletion_request	insert	product, data		Creates a data deletion request by providing a query and a timeframe targeting the proper data.
cancel_data_deletion_request	exec	id		Cancels a data deletion request by providing its ID.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	ID of the deletion request.
product	string	Name of the product to be deleted. Only logs is supported.
site	string	The Datadog site (region) for your organization, for example datadoghq.com, us3.datadoghq.com, us5.datadoghq.com, ap1.datadoghq.com, ap2.datadoghq.com, datadoghq.eu, ddog-gov.com. Resolved from the DD_SITE environment variable when set. Optional: defaults to datadoghq.com, or the value of the DD_SITE environment variable when set; a WHERE value overrides both.
next_page	string	The next page of the previous search. If the next_page parameter is included, the rest of the query elements are ignored. (example: cGFnZTI=)
page_size	integer (int64)	Sets the page size of the search. (example: 50)
product	string	Retrieve only the requests related to the given product. (example: logs)
query	string	Retrieve only the requests that matches the given query. (example: service:xyz host:abc)
status	string	Retrieve only the requests with the given status. (example: pending)

SELECT examples

get_data_deletion_requests

Gets a list of data deletion requests based on several filter parameters.

SELECT
id,
attributes,
type
FROM datadog.organization.data_deletion_requests
WHERE next_page = '{{ next_page }}'
AND product = '{{ product }}'
AND query = '{{ query }}'
AND status = '{{ status }}'
AND page_size = '{{ page_size }}'
;

INSERT examples

create_data_deletion_request

Creates a data deletion request by providing a query and a timeframe targeting the proper data.

INSERT INTO datadog.organization.data_deletion_requests (
data,
product
)
SELECT 
'{{ data }}' /* required */,
'{{ product }}'
RETURNING
data,
meta
;

Manifest

# Description fields are for documentation purposes
- name: data_deletion_requests
props:
  - name: product
    value: "{{ product }}"
    description: Required parameter for the data_deletion_requests resource.
  - name: data
    description: |
      Data needed to create a data deletion request.
    value:
      attributes:
        displayed_total: {{ displayed_total }}
        from: {{ from }}
        indexes:
          - "{{ indexes }}"
        query: "{{ query }}"
        to: {{ to }}
      type: "{{ type }}"

Lifecycle Methods

EXEC variables use wire (API) names.

cancel_data_deletion_request

Cancels a data deletion request by providing its ID.

EXEC datadog.organization.data_deletion_requests.cancel_data_deletion_request 
@id='{{ id }}' --required 
;