Get Segment Definition

customerprofiles_get_segment_definition

R Documentation

Gets a segment definition from the domain

Description

Gets a segment definition from the domain.

Usage

customerprofiles_get_segment_definition(DomainName,
  SegmentDefinitionName)

Arguments

DomainName

[required] The unique name of the domain.

SegmentDefinitionName

[required] The unique name of the segment definition.

Value

A list with the following syntax:

list(
  SegmentDefinitionName = "string",
  DisplayName = "string",
  Description = "string",
  SegmentGroups = list(
    Groups = list(
      list(
        Dimensions = list(
          list(
            ProfileAttributes = list(
              AccountNumber = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              AdditionalInformation = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              FirstName = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              LastName = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              MiddleName = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              GenderString = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              PartyTypeString = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              BirthDate = list(
                DimensionType = "BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON",
                Values = list(
                  "string"
                )
              ),
              PhoneNumber = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              BusinessName = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              BusinessPhoneNumber = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              HomePhoneNumber = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              MobilePhoneNumber = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              EmailAddress = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              PersonalEmailAddress = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              BusinessEmailAddress = list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                Values = list(
                  "string"
                )
              ),
              Address = list(
                City = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Country = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                County = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                PostalCode = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Province = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                State = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                )
              ),
              ShippingAddress = list(
                City = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Country = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                County = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                PostalCode = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Province = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                State = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                )
              ),
              MailingAddress = list(
                City = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Country = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                County = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                PostalCode = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Province = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                State = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                )
              ),
              BillingAddress = list(
                City = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Country = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                County = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                PostalCode = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                Province = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                ),
                State = list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH",
                  Values = list(
                    "string"
                  )
                )
              ),
              Attributes = list(
                list(
                  DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
                  Values = list(
                    "string"
                  )
                )
              )
            ),
            CalculatedAttributes = list(
              list(
                DimensionType = "INCLUSIVE"|"EXCLUSIVE"|"CONTAINS"|"BEGINS_WITH"|"ENDS_WITH"|"BEFORE"|"AFTER"|"BETWEEN"|"NOT_BETWEEN"|"ON"|"GREATER_THAN"|"LESS_THAN"|"GREATER_THAN_OR_EQUAL"|"LESS_THAN_OR_EQUAL"|"EQUAL",
                Values = list(
                  "string"
                ),
                ConditionOverrides = list(
                  Range = list(
                    Start = 123,
                    End = 123,
                    Unit = "DAYS"
                  )
                )
              )
            )
          )
        ),
        SourceSegments = list(
          list(
            SegmentDefinitionName = "string"
          )
        ),
        SourceType = "ALL"|"ANY"|"NONE",
        Type = "ALL"|"ANY"|"NONE"
      )
    ),
    Include = "ALL"|"ANY"|"NONE"
  ),
  SegmentDefinitionArn = "string",
  CreatedAt = as.POSIXct(
    "2015-01-01"
  ),
  Tags = list(
    "string"
  )
)

Request syntax

svc$get_segment_definition(
  DomainName = "string",
  SegmentDefinitionName = "string"
)