Class: Aws::IVSRealTime::Types::CompositionSummary

Inherits:

Struct

• Object
• Struct
• Aws::IVSRealTime::Types::CompositionSummary

Includes:

Structure

Defined in:

lib/aws-sdk-ivsrealtime/types.rb

Overview

Summary information about a Composition.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  ARN of the Composition resource.

• #destinations ⇒ Array<Types::DestinationSummary>

  Array of Destination objects.

• #end_time ⇒ Time

  UTC time of the Composition end.

• #stage_arn ⇒ String

  ARN of the attached stage.

• #start_time ⇒ Time

  UTC time of the Composition start.

• #state ⇒ String

  State of the Composition resource.

• #tags ⇒ Hash<String,String>

  Tags attached to the resource.

Instance Attribute Details

#arn ⇒ String

ARN of the Composition resource.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#destinations ⇒ Array<Types::DestinationSummary>

Array of Destination objects.

Returns:

• (Array<Types::DestinationSummary>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#end_time ⇒ Time

UTC time of the Composition end. This is an ISO 8601 timestamp; *note that this is returned as a string*.

Returns:

• (Time)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#stage_arn ⇒ String

ARN of the attached stage.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ Time

UTC time of the Composition start. This is an ISO 8601 timestamp; *note that this is returned as a string*.

Returns:

• (Time)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

State of the Composition resource.

Returns:

• (String)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

Tags attached to the resource. Array of maps, each of the form ‘string:string (key:value)`. See [Best practices and strategies] in *Tagging AWS Resources and Tag Editor* for details, including restrictions that apply to tags and “Tag naming limits and requirements”; Amazon IVS has no constraints on tags beyond what is documented there.

[1]: docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-ivsrealtime/types.rb', line 175

class CompositionSummary < Struct.new(
  :arn,
  :stage_arn,
  :destinations,
  :state,
  :tags,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end