Class: Aws::Chime::Types::CreateMediaCapturePipelineRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb

Overview

Note:

When making an API call, you may pass CreateMediaCapturePipelineRequest data as a hash:

{
  source_type: "ChimeSdkMeeting", # required, accepts ChimeSdkMeeting
  source_arn: "Arn", # required
  sink_type: "S3Bucket", # required, accepts S3Bucket
  sink_arn: "Arn", # required
  client_request_token: "ClientRequestToken",
  chime_sdk_meeting_configuration: {
    source_configuration: {
      selected_video_streams: {
        attendee_ids: ["GuidString"],
        external_user_ids: ["ExternalUserIdType"],
      },
    },
    artifacts_configuration: {
      audio: { # required
        mux_type: "AudioOnly", # required, accepts AudioOnly, AudioWithActiveSpeakerVideo
      },
      video: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "VideoOnly", # accepts VideoOnly
      },
      content: { # required
        state: "Enabled", # required, accepts Enabled, Disabled
        mux_type: "ContentOnly", # accepts ContentOnly
      },
    },
  },
}

Constant Summary collapse

SENSITIVE =
[:source_arn, :sink_arn, :client_request_token]

Instance Attribute Summary collapse

Instance Attribute Details

#chime_sdk_meeting_configurationTypes::ChimeSdkMeetingConfiguration

The configuration for a specified media capture pipeline. SourceType must be ChimeSdkMeeting.



2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end

#client_request_tokenString

The token assigned to the client making the pipeline request.

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String)


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end

#sink_arnString

The ARN of the sink type.

Returns:

  • (String)


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end

#sink_typeString

Destination type to which the media artifacts are saved. You must use an S3 bucket.

Returns:

  • (String)


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end

#source_arnString

ARN of the source from which the media artifacts are captured.

Returns:

  • (String)


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end

#source_typeString

Source type from which the media artifacts will be captured. A Chime SDK Meeting is the only supported source.

Returns:

  • (String)


2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
# File 'gems/aws-sdk-chime/lib/aws-sdk-chime/types.rb', line 2333

class CreateMediaCapturePipelineRequest < Struct.new(
  :source_type,
  :source_arn,
  :sink_type,
  :sink_arn,
  :client_request_token,
  :chime_sdk_meeting_configuration)
  SENSITIVE = [:source_arn, :sink_arn, :client_request_token]
  include Aws::Structure
end