Skip to content

Returns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments

Description

Returns information about the segment membership event stream configured for a specific domain, including the stream state and associated segments.

Usage

customerprofiles_get_stream_for_segments(DomainName)

Arguments

  • DomainName

[required] The unique name of the domain.

Value

A list with the following syntax:

list(
  AssociatedAt = as.POSIXct(
    "2015-01-01"
  ),
  AssociatedSegments = list(
    list(
      SegmentName = "string",
      Status = "STARTING"|"RUNNING"|"STOPPED"|"FAILED",
      Message = "string"
    )
  ),
  DomainName = "string",
  DestinationArn = "string",
  DestinationRoleArn = "string",
  State = "RUNNING"|"UNHEALTHY"|"STOPPED",
  DisassociatedAt = as.POSIXct(
    "2015-01-01"
  ),
  FailureReason = "string"
)

Request syntax

svc$get_stream_for_segments(
  DomainName = "string"
)