Class: Aws::ChimeSDKMediaPipelines::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::ChimeSDKMediaPipelines::Client
- Includes:
- Aws::ClientStubs
- Defined in:
- lib/aws-sdk-chimesdkmediapipelines/client.rb
Overview
An API client for ChimeSDKMediaPipelines. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::ChimeSDKMediaPipelines::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#create_media_capture_pipeline(params = {}) ⇒ Types::CreateMediaCapturePipelineResponse
Creates a media pipeline.
-
#create_media_concatenation_pipeline(params = {}) ⇒ Types::CreateMediaConcatenationPipelineResponse
Creates a media concatenation pipeline.
-
#create_media_insights_pipeline(params = {}) ⇒ Types::CreateMediaInsightsPipelineResponse
Creates a media insights pipeline.
-
#create_media_insights_pipeline_configuration(params = {}) ⇒ Types::CreateMediaInsightsPipelineConfigurationResponse
A structure that contains the static configurations for a media insights pipeline.
-
#create_media_live_connector_pipeline(params = {}) ⇒ Types::CreateMediaLiveConnectorPipelineResponse
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
-
#create_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::CreateMediaPipelineKinesisVideoStreamPoolResponse
Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.
-
#create_media_stream_pipeline(params = {}) ⇒ Types::CreateMediaStreamPipelineResponse
Creates a streaming media pipeline.
-
#delete_media_capture_pipeline(params = {}) ⇒ Struct
Deletes the media pipeline.
-
#delete_media_insights_pipeline_configuration(params = {}) ⇒ Struct
Deletes the specified configuration settings.
-
#delete_media_pipeline(params = {}) ⇒ Struct
Deletes the media pipeline.
-
#delete_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Struct
Deletes an Amazon Kinesis Video Stream pool.
-
#get_media_capture_pipeline(params = {}) ⇒ Types::GetMediaCapturePipelineResponse
Gets an existing media pipeline.
-
#get_media_insights_pipeline_configuration(params = {}) ⇒ Types::GetMediaInsightsPipelineConfigurationResponse
Gets the configuration settings for a media insights pipeline.
-
#get_media_pipeline(params = {}) ⇒ Types::GetMediaPipelineResponse
Gets an existing media pipeline.
-
#get_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::GetMediaPipelineKinesisVideoStreamPoolResponse
Gets an Kinesis video stream pool.
-
#get_speaker_search_task(params = {}) ⇒ Types::GetSpeakerSearchTaskResponse
Retrieves the details of the specified speaker search task.
-
#get_voice_tone_analysis_task(params = {}) ⇒ Types::GetVoiceToneAnalysisTaskResponse
Retrieves the details of a voice tone analysis task.
-
#list_media_capture_pipelines(params = {}) ⇒ Types::ListMediaCapturePipelinesResponse
Returns a list of media pipelines.
-
#list_media_insights_pipeline_configurations(params = {}) ⇒ Types::ListMediaInsightsPipelineConfigurationsResponse
Lists the available media insights pipeline configurations.
-
#list_media_pipeline_kinesis_video_stream_pools(params = {}) ⇒ Types::ListMediaPipelineKinesisVideoStreamPoolsResponse
Lists the video stream pools in the media pipeline.
-
#list_media_pipelines(params = {}) ⇒ Types::ListMediaPipelinesResponse
Returns a list of media pipelines.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags available for a media pipeline.
-
#start_speaker_search_task(params = {}) ⇒ Types::StartSpeakerSearchTaskResponse
Starts a speaker search task.
-
#start_voice_tone_analysis_task(params = {}) ⇒ Types::StartVoiceToneAnalysisTaskResponse
Starts a voice tone analysis task.
-
#stop_speaker_search_task(params = {}) ⇒ Struct
Stops a speaker search task.
-
#stop_voice_tone_analysis_task(params = {}) ⇒ Struct
Stops a voice tone analysis task.
-
#tag_resource(params = {}) ⇒ Struct
The ARN of the media pipeline that you want to tag.
-
#untag_resource(params = {}) ⇒ Struct
Removes any tags from a media pipeline.
-
#update_media_insights_pipeline_configuration(params = {}) ⇒ Types::UpdateMediaInsightsPipelineConfigurationResponse
Updates the media insights pipeline’s configuration settings.
-
#update_media_insights_pipeline_status(params = {}) ⇒ Struct
Updates the status of a media insights pipeline.
-
#update_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::UpdateMediaPipelineKinesisVideoStreamPoolResponse
Updates an Amazon Kinesis Video Stream pool in a media pipeline.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
444 445 446 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 444 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2575 2576 2577 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2575 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2578 2579 2580 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2578 def errors_module Errors end |
Instance Method Details
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2548 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) tracer = config.telemetry_provider.tracer_provider.tracer( Aws::Telemetry.module_to_tracer_name('Aws::ChimeSDKMediaPipelines') ) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config, tracer: tracer ) context[:gem_name] = 'aws-sdk-chimesdkmediapipelines' context[:gem_version] = '1.33.0' Seahorse::Client::Request.new(handlers, context) end |
#create_media_capture_pipeline(params = {}) ⇒ Types::CreateMediaCapturePipelineResponse
Creates a media pipeline.
597 598 599 600 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 597 def create_media_capture_pipeline(params = {}, = {}) req = build_request(:create_media_capture_pipeline, params) req.send_request() end |
#create_media_concatenation_pipeline(params = {}) ⇒ Types::CreateMediaConcatenationPipelineResponse
Creates a media concatenation pipeline.
705 706 707 708 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 705 def create_media_concatenation_pipeline(params = {}, = {}) req = build_request(:create_media_concatenation_pipeline, params) req.send_request() end |
#create_media_insights_pipeline(params = {}) ⇒ Types::CreateMediaInsightsPipelineResponse
Creates a media insights pipeline.
831 832 833 834 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 831 def create_media_insights_pipeline(params = {}, = {}) req = build_request(:create_media_insights_pipeline, params) req.send_request() end |
#create_media_insights_pipeline_configuration(params = {}) ⇒ Types::CreateMediaInsightsPipelineConfigurationResponse
A structure that contains the static configurations for a media insights pipeline.
1042 1043 1044 1045 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1042 def create_media_insights_pipeline_configuration(params = {}, = {}) req = build_request(:create_media_insights_pipeline_configuration, params) req.send_request() end |
#create_media_live_connector_pipeline(params = {}) ⇒ Types::CreateMediaLiveConnectorPipelineResponse
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
1181 1182 1183 1184 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1181 def create_media_live_connector_pipeline(params = {}, = {}) req = build_request(:create_media_live_connector_pipeline, params) req.send_request() end |
#create_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::CreateMediaPipelineKinesisVideoStreamPoolResponse
Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.
<note markdown=“1”> If a meeting uses an opt-in Region as its [MediaRegion], the KVS stream must be in that same Region. For example, if a meeting uses the ‘af-south-1` Region, the KVS stream must also be in `af-south-1`. However, if the meeting uses a Region that AWS turns on by default, the KVS stream can be in any available Region, including an opt-in Region. For example, if the meeting uses `ca-central-1`, the KVS stream can be in `eu-west-2`, `us-east-1`, `af-south-1`, or any other Region that the Amazon Chime SDK supports.
To learn which AWS Region a meeting uses, call the [GetMeeting][2] API
and use the [MediaRegion] parameter from the response.
For more information about opt-in Regions, refer to [Available
Regions] in the *Amazon Chime SDK Developer Guide*, and [Specify which AWS Regions your account can use], in the *AWS Account Management Reference Guide*.
</note>
[1]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_CreateMeeting.html#chimesdk-meeting-chime_CreateMeeting-request-MediaRegion [2]: docs.aws.amazon.com/chime-sdk/latest/APIReference/API_meeting-chime_GetMeeting.html [3]: docs.aws.amazon.com/chime-sdk/latest/dg/sdk-available-regions.html [4]: docs.aws.amazon.com/accounts/latest/reference/manage-acct-regions.html#rande-manage-enable.html
1267 1268 1269 1270 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1267 def create_media_pipeline_kinesis_video_stream_pool(params = {}, = {}) req = build_request(:create_media_pipeline_kinesis_video_stream_pool, params) req.send_request() end |
#create_media_stream_pipeline(params = {}) ⇒ Types::CreateMediaStreamPipelineResponse
Creates a streaming media pipeline.
1339 1340 1341 1342 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1339 def create_media_stream_pipeline(params = {}, = {}) req = build_request(:create_media_stream_pipeline, params) req.send_request() end |
#delete_media_capture_pipeline(params = {}) ⇒ Struct
Deletes the media pipeline.
1361 1362 1363 1364 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1361 def delete_media_capture_pipeline(params = {}, = {}) req = build_request(:delete_media_capture_pipeline, params) req.send_request() end |
#delete_media_insights_pipeline_configuration(params = {}) ⇒ Struct
Deletes the specified configuration settings.
1384 1385 1386 1387 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1384 def delete_media_insights_pipeline_configuration(params = {}, = {}) req = build_request(:delete_media_insights_pipeline_configuration, params) req.send_request() end |
#delete_media_pipeline(params = {}) ⇒ Struct
Deletes the media pipeline.
1406 1407 1408 1409 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1406 def delete_media_pipeline(params = {}, = {}) req = build_request(:delete_media_pipeline, params) req.send_request() end |
#delete_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Struct
Deletes an Amazon Kinesis Video Stream pool.
1429 1430 1431 1432 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1429 def delete_media_pipeline_kinesis_video_stream_pool(params = {}, = {}) req = build_request(:delete_media_pipeline_kinesis_video_stream_pool, params) req.send_request() end |
#get_media_capture_pipeline(params = {}) ⇒ Types::GetMediaCapturePipelineResponse
Gets an existing media pipeline.
1492 1493 1494 1495 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1492 def get_media_capture_pipeline(params = {}, = {}) req = build_request(:get_media_capture_pipeline, params) req.send_request() end |
#get_media_insights_pipeline_configuration(params = {}) ⇒ Types::GetMediaInsightsPipelineConfigurationResponse
Gets the configuration settings for a media insights pipeline.
1583 1584 1585 1586 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1583 def get_media_insights_pipeline_configuration(params = {}, = {}) req = build_request(:get_media_insights_pipeline_configuration, params) req.send_request() end |
#get_media_pipeline(params = {}) ⇒ Types::GetMediaPipelineResponse
Gets an existing media pipeline.
1739 1740 1741 1742 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1739 def get_media_pipeline(params = {}, = {}) req = build_request(:get_media_pipeline, params) req.send_request() end |
#get_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::GetMediaPipelineKinesisVideoStreamPoolResponse
Gets an Kinesis video stream pool.
1776 1777 1778 1779 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1776 def get_media_pipeline_kinesis_video_stream_pool(params = {}, = {}) req = build_request(:get_media_pipeline_kinesis_video_stream_pool, params) req.send_request() end |
#get_speaker_search_task(params = {}) ⇒ Types::GetSpeakerSearchTaskResponse
Retrieves the details of the specified speaker search task.
1812 1813 1814 1815 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1812 def get_speaker_search_task(params = {}, = {}) req = build_request(:get_speaker_search_task, params) req.send_request() end |
#get_voice_tone_analysis_task(params = {}) ⇒ Types::GetVoiceToneAnalysisTaskResponse
Retrieves the details of a voice tone analysis task.
1848 1849 1850 1851 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1848 def get_voice_tone_analysis_task(params = {}, = {}) req = build_request(:get_voice_tone_analysis_task, params) req.send_request() end |
#list_media_capture_pipelines(params = {}) ⇒ Types::ListMediaCapturePipelinesResponse
Returns a list of media pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1887 1888 1889 1890 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1887 def list_media_capture_pipelines(params = {}, = {}) req = build_request(:list_media_capture_pipelines, params) req.send_request() end |
#list_media_insights_pipeline_configurations(params = {}) ⇒ Types::ListMediaInsightsPipelineConfigurationsResponse
Lists the available media insights pipeline configurations.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1926 1927 1928 1929 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1926 def list_media_insights_pipeline_configurations(params = {}, = {}) req = build_request(:list_media_insights_pipeline_configurations, params) req.send_request() end |
#list_media_pipeline_kinesis_video_stream_pools(params = {}) ⇒ Types::ListMediaPipelineKinesisVideoStreamPoolsResponse
Lists the video stream pools in the media pipeline.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1965 1966 1967 1968 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 1965 def list_media_pipeline_kinesis_video_stream_pools(params = {}, = {}) req = build_request(:list_media_pipeline_kinesis_video_stream_pools, params) req.send_request() end |
#list_media_pipelines(params = {}) ⇒ Types::ListMediaPipelinesResponse
Returns a list of media pipelines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2004 2005 2006 2007 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2004 def list_media_pipelines(params = {}, = {}) req = build_request(:list_media_pipelines, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
Lists the tags available for a media pipeline.
2035 2036 2037 2038 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2035 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#start_speaker_search_task(params = {}) ⇒ Types::StartSpeakerSearchTaskResponse
Starts a speaker search task.
Before starting any speaker search tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms] for the Amazon Chime SDK.
2097 2098 2099 2100 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2097 def start_speaker_search_task(params = {}, = {}) req = build_request(:start_speaker_search_task, params) req.send_request() end |
#start_voice_tone_analysis_task(params = {}) ⇒ Types::StartVoiceToneAnalysisTaskResponse
Starts a voice tone analysis task. For more information about voice tone analysis, see [Using Amazon Chime SDK voice analytics] in the *Amazon Chime SDK Developer Guide*.
Before starting any voice tone analysis tasks, you must provide all notices and obtain all consents from the speaker as required under applicable privacy and biometrics laws, and as required under the [AWS service terms] for the Amazon Chime SDK.
[1]: docs.aws.amazon.com/chime-sdk/latest/dg/voice-analytics.html [2]: aws.amazon.com/service-terms/
2162 2163 2164 2165 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2162 def start_voice_tone_analysis_task(params = {}, = {}) req = build_request(:start_voice_tone_analysis_task, params) req.send_request() end |
#stop_speaker_search_task(params = {}) ⇒ Struct
Stops a speaker search task.
2189 2190 2191 2192 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2189 def stop_speaker_search_task(params = {}, = {}) req = build_request(:stop_speaker_search_task, params) req.send_request() end |
#stop_voice_tone_analysis_task(params = {}) ⇒ Struct
Stops a voice tone analysis task.
2216 2217 2218 2219 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2216 def stop_voice_tone_analysis_task(params = {}, = {}) req = build_request(:stop_voice_tone_analysis_task, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
The ARN of the media pipeline that you want to tag. Consists of the pipeline’s endpoint region, resource ID, and pipeline ID.
2250 2251 2252 2253 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2250 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes any tags from a media pipeline.
2276 2277 2278 2279 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2276 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_media_insights_pipeline_configuration(params = {}) ⇒ Types::UpdateMediaInsightsPipelineConfigurationResponse
Updates the media insights pipeline’s configuration settings.
2469 2470 2471 2472 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2469 def update_media_insights_pipeline_configuration(params = {}, = {}) req = build_request(:update_media_insights_pipeline_configuration, params) req.send_request() end |
#update_media_insights_pipeline_status(params = {}) ⇒ Struct
Updates the status of a media insights pipeline.
2496 2497 2498 2499 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2496 def update_media_insights_pipeline_status(params = {}, = {}) req = build_request(:update_media_insights_pipeline_status, params) req.send_request() end |
#update_media_pipeline_kinesis_video_stream_pool(params = {}) ⇒ Types::UpdateMediaPipelineKinesisVideoStreamPoolResponse
Updates an Amazon Kinesis Video Stream pool in a media pipeline.
2539 2540 2541 2542 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2539 def update_media_pipeline_kinesis_video_stream_pool(params = {}, = {}) req = build_request(:update_media_pipeline_kinesis_video_stream_pool, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
2568 2569 2570 |
# File 'lib/aws-sdk-chimesdkmediapipelines/client.rb', line 2568 def waiter_names [] end |