segment_definitions

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

Overview

Name	segment_definitions
Type	Resource
Id	aws.customer_profiles.segment_definitions

Fields

The following fields are returned by SELECT queries:

get_segment_definition

Name	Datatype	Description
created_at	string (date-time)	The timestamp of when the segment definition was created.
description	string	The description of the segment definition.
display_name	string	The display name of the segment definition.
segment_definition_arn	string	The arn of the segment definition.
segment_definition_name	string	The name of the segment definition. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
segment_groups	object	Contains all groups of the segment definition.
segment_sort	object	Defines how segments should be sorted and ordered in the results.
segment_sql_query	string	The segment SQL query.
segment_type	string	The segment type. Classic : Segments created using traditional SegmentGroup structure Enhanced : Segments created using SQL queries (CLASSIC, ENHANCED)
tags	object	The tags used to organize, track, or control access for this resource.

list_segment_definitions

Name	Datatype	Description
created_at	string (date-time)	When the segment definition was created.
description	string	The description of the segment definition.
display_name	string	Display name of the segment definition.
segment_definition_arn	string	The arn of the segment definition.
segment_definition_name	string	Name of the segment definition. (pattern: <code>^[a-zA-Z0-9_-]+$</code>)
segment_type	string	The segment type. Classic : Segments created using traditional SegmentGroup structure Enhanced : Segments created using SQL queries (CLASSIC, ENHANCED)
tags	object	The tags belonging to the segment definition.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_segment_definition	select	domain_name, segment_definition_name, region		Gets a segment definition from the domain.
list_segment_definitions	select	domain_name, region	max-results, next-token	Lists all segment definitions under a domain.
create_segment_definition	insert	domain_name, segment_definition_name, region, DisplayName		Creates a segment definition associated to the given domain.
delete_segment_definition	delete	domain_name, segment_definition_name, region		Deletes a segment definition from the domain.

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
domain_name	string	The unique name of the domain.
region	string	AWS region (default: us-east-1)
segment_definition_name	string	The unique name of the segment definition.
max-results	integer	The maximum number of objects returned per page.
next-token	string	The pagination token from the previous call.

SELECT examples

get_segment_definition

Gets a segment definition from the domain.

SELECT
created_at,
description,
display_name,
segment_definition_arn,
segment_definition_name,
segment_groups,
segment_sort,
segment_sql_query,
segment_type,
tags
FROM aws.customer_profiles.segment_definitions
WHERE domain_name = '{{ domain_name }}' -- required
AND segment_definition_name = '{{ segment_definition_name }}' -- required
AND region = '{{ region }}' -- required
;

list_segment_definitions

Lists all segment definitions under a domain.

SELECT
created_at,
description,
display_name,
segment_definition_arn,
segment_definition_name,
segment_type,
tags
FROM aws.customer_profiles.segment_definitions
WHERE domain_name = '{{ domain_name }}' -- required
AND region = '{{ region }}' -- required
AND `max-results` = '{{ max-results }}'
AND `next-token` = '{{ next-token }}'
;

INSERT examples

create_segment_definition

Creates a segment definition associated to the given domain.

INSERT INTO aws.customer_profiles.segment_definitions (
DisplayName,
Description,
SegmentGroups,
SegmentSqlQuery,
SegmentSort,
Tags,
domain_name,
segment_definition_name,
region
)
SELECT 
'{{ DisplayName }}' /* required */,
'{{ Description }}',
'{{ SegmentGroups }}',
'{{ SegmentSqlQuery }}',
'{{ SegmentSort }}',
'{{ Tags }}',
'{{ domain_name }}',
'{{ segment_definition_name }}',
'{{ region }}'
RETURNING
created_at,
description,
display_name,
segment_definition_arn,
segment_definition_name,
tags
;

Manifest

# Description fields are for documentation purposes
- name: segment_definitions
props:
  - name: domain_name
    value: "{{ domain_name }}"
    description: Required parameter for the segment_definitions resource.
  - name: segment_definition_name
    value: "{{ segment_definition_name }}"
    description: Required parameter for the segment_definitions resource.
  - name: region
    value: "{{ region }}"
    description: Required parameter for the segment_definitions resource.
  - name: DisplayName
    value: "{{ DisplayName }}"
  - name: Description
    value: "{{ Description }}"
  - name: SegmentGroups
    description: |
      Contains all groups of the segment definition.
    value:
      Groups:
        - Dimensions: "{{ Dimensions }}"
          SourceSegments: "{{ SourceSegments }}"
          SourceType: "{{ SourceType }}"
          Type: "{{ Type }}"
      Include: "{{ Include }}"
  - name: SegmentSqlQuery
    value: "{{ SegmentSqlQuery }}"
  - name: SegmentSort
    description: |
      Defines how segments should be sorted and ordered in the results.
    value:
      Attributes:
        - Name: "{{ Name }}"
          DataType: "{{ DataType }}"
          Order: "{{ Order }}"
          Type: "{{ Type }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_segment_definition

Deletes a segment definition from the domain.

DELETE FROM aws.customer_profiles.segment_definitions
WHERE domain_name = '{{ domain_name }}' --required
AND segment_definition_name = '{{ segment_definition_name }}' --required
AND region = '{{ region }}' --required
;