Skip to content

Returns the current subscription configuration, execution schedule, and status for segment membership events

Description

Returns the current subscription configuration, execution schedule, and status for segment membership events.

Usage

customerprofiles_get_segment_subscription(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(
  Status = "STARTING"|"RUNNING"|"STOPPED"|"FAILED",
  Message = "string",
  ScheduleConfiguration = list(
    Interval = 123,
    Unit = "HOURLY"
  ),
  ScheduledExecutions = list(
    NextExecutedAt = as.POSIXct(
      "2015-01-01"
    ),
    LastExecutedAt = as.POSIXct(
      "2015-01-01"
    )
  ),
  StartedAt = as.POSIXct(
    "2015-01-01"
  ),
  LastUpdatedAt = as.POSIXct(
    "2015-01-01"
  )
)

Request syntax

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