incident_impacts

Creates, updates, deletes, gets or lists an incident_impacts resource.

Overview

Name	incident_impacts
Type	Resource
Id	datadog.service_management.incident_impacts

Fields

The following fields are returned by SELECT queries:

list_incident_impacts

Name	Datatype	Description
id	string	The incident impact's ID. (example: 00000000-0000-0000-1234-000000000000)
attributes	object	The incident impact's attributes.
relationships	object	The incident impact's resource relationships.
type	string	Incident impact resource type. (incident_impacts) (default: incident_impacts, example: incident_impacts)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_incident_impacts	select	incident_id	include	Get all impacts for an incident.
create_incident_impact	insert	incident_id, data	include	Create an impact for an incident.
patch_incident_impact	update	incident_id, impact_id, data	include	Update an incident impact.
delete_incident_impact	delete	incident_id, impact_id		Delete an incident impact.

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
impact_id	string	The UUID of the incident impact.
incident_id	string	The UUID of the incident.
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.
include	array	Specifies which related resources should be included in the response.

SELECT examples

list_incident_impacts

Get all impacts for an incident.

SELECT
id,
attributes,
relationships,
type
FROM datadog.service_management.incident_impacts
WHERE incident_id = '{{ incident_id }}' -- required
AND include = '{{ include }}'
;

INSERT examples

create_incident_impact

Create an impact for an incident.

INSERT INTO datadog.service_management.incident_impacts (
data,
incident_id,
include
)
SELECT 
'{{ data }}' /* required */,
'{{ incident_id }}',
'{{ include }}'
RETURNING
data,
included
;

Manifest

# Description fields are for documentation purposes
- name: incident_impacts
props:
  - name: incident_id
    value: "{{ incident_id }}"
    description: Required parameter for the incident_impacts resource.
  - name: data
    description: |
      Incident impact data for a create request.
    value:
      attributes:
        description: "{{ description }}"
        end_at: "{{ end_at }}"
        fields: "{{ fields }}"
        start_at: "{{ start_at }}"
      type: "{{ type }}"
  - name: include
    value: "{{ include }}"
    description: Specifies which related resources should be included in the response.
    description: Specifies which related resources should be included in the response.

UPDATE examples

patch_incident_impact

Update an incident impact.

UPDATE datadog.service_management.incident_impacts
SET 
data = '{{ data }}'
WHERE 
incident_id = '{{ incident_id }}' --required
AND impact_id = '{{ impact_id }}' --required
AND data = '{{ data }}' --required
AND include = '{{ include}}'
RETURNING
data,
included;

DELETE examples

delete_incident_impact

Delete an incident impact.

DELETE FROM datadog.service_management.incident_impacts
WHERE incident_id = '{{ incident_id }}' --required
AND impact_id = '{{ impact_id }}' --required
;