Class: Aws::CustomerProfiles::Types::GetStreamForSegmentsResponse

Inherits:

Struct

• Object
• Struct
• Aws::CustomerProfiles::Types::GetStreamForSegmentsResponse

Includes:

Structure

Defined in:

lib/aws-sdk-customerprofiles/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #associated_at ⇒ Time

  The timestamp of when the stream was associated.

• #associated_segments ⇒ Array<Types::AssociatedSegment>

  A list of segments currently associated with the stream and their subscription status.

• #destination_arn ⇒ String

  The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.

• #destination_role_arn ⇒ String

  The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.

• #disassociated_at ⇒ Time

  The timestamp of when the stream was disassociated.

• #domain_name ⇒ String

  The unique name of the domain.

• #failure_reason ⇒ String

  The reason why the stream is in an unhealthy state, if applicable.

• #state ⇒ String

  The operational state of the destination stream.

Instance Attribute Details

#associated_at ⇒ Time

The timestamp of when the stream was associated.

Returns:

• (Time)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#associated_segments ⇒ Array<Types::AssociatedSegment>

A list of segments currently associated with the stream and their subscription status.

Returns:

• (Array<Types::AssociatedSegment>)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#destination_arn ⇒ String

The Amazon Resource Name (ARN) of the Amazon Kinesis data stream receiving segment membership events.

Returns:

• (String)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#destination_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role used for Amazon Kinesis and AWS Key Management Service (KMS) operations.

Returns:

• (String)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#disassociated_at ⇒ Time

The timestamp of when the stream was disassociated.

Returns:

• (Time)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#domain_name ⇒ String

The unique name of the domain.

Returns:

• (String)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#failure_reason ⇒ String

The reason why the stream is in an unhealthy state, if applicable.

Returns:

• (String)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The operational state of the destination stream. The following are valid values:

• RUNNING: The stream is associated and healthy. Segment membership events are being published.

• UNHEALTHY: The stream is associated but events cannot currently be published. See FailureReason for details.

• STOPPED: The stream is no longer publishing segment membership events.

Returns:

• (String)

# File 'lib/aws-sdk-customerprofiles/types.rb', line 5718

class GetStreamForSegmentsResponse < Struct.new(
  :associated_at,
  :associated_segments,
  :domain_name,
  :destination_arn,
  :destination_role_arn,
  :state,
  :disassociated_at,
  :failure_reason)
  SENSITIVE = []
  include Aws::Structure
end