media_insights_pipeline_configurations

Creates, updates, deletes, gets or lists a media_insights_pipeline_configurations resource.

Overview

Name	media_insights_pipeline_configurations
Type	Resource
Id	aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations

Fields

The following fields are returned by SELECT queries:

get_media_insights_pipeline_configuration

Name	Datatype	Description
created_timestamp	string (date-time)	The time at which the configuration was created.
elements	array	The elements in the configuration.
media_insights_pipeline_configuration_arn	string	The ARN of the configuration. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
media_insights_pipeline_configuration_id	string	The ID of the configuration. (pattern: <code>[a-fA-F0-9]{8}(?:-[a-fA-F0-9]{4}){3}-[a-fA-F0-9]{12}</code>)
media_insights_pipeline_configuration_name	string	The name of the configuration. (pattern: <code>^[0-9a-zA-Z._-]+</code>)
real_time_alert_configuration	object	A structure that contains the configuration settings for real-time alerts.
resource_access_role_arn	string	The ARN of the role used by the service to access Amazon Web Services resources. (pattern: <code>^arn[/:-_.a-zA-Z0-9]+$</code>)
updated_timestamp	string (date-time)	The time at which the configuration was last updated.

list_media_insights_pipeline_configurations

Name	Datatype	Description
media_insights_pipeline_configurations	array	The requested list of media insights pipeline configurations.
next_token	string	The token used to return the next page of results. (pattern: <code>.*</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_media_insights_pipeline_configuration	select	identifier, region		Gets the configuration settings for a media insights pipeline.
list_media_insights_pipeline_configurations	select	region	next-token, max-results	Lists the available media insights pipeline configurations.
create_media_insights_pipeline_configuration	insert	region, MediaInsightsPipelineConfigurationName, ResourceAccessRoleArn, Elements		A structure that contains the static configurations for a media insights pipeline.
create_media_insights_pipeline	insert	region, MediaInsightsPipelineConfigurationArn		Creates a media insights pipeline.
update_media_insights_pipeline_configuration	update	identifier, region, ResourceAccessRoleArn, Elements		Updates the media insights pipeline's configuration settings.
delete_media_insights_pipeline_configuration	delete	identifier, region		Deletes the specified configuration settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
identifier	string	The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.
region	string	AWS region (default: us-east-1)
max-results	integer	The maximum number of results to return in a single call.
next-token	string	The token used to return the next page of results.

SELECT examples

get_media_insights_pipeline_configuration

Gets the configuration settings for a media insights pipeline.

SELECT
created_timestamp,
elements,
media_insights_pipeline_configuration_arn,
media_insights_pipeline_configuration_id,
media_insights_pipeline_configuration_name,
real_time_alert_configuration,
resource_access_role_arn,
updated_timestamp
FROM aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations
WHERE identifier = '{{ identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_media_insights_pipeline_configurations

Lists the available media insights pipeline configurations.

SELECT
media_insights_pipeline_configurations,
next_token
FROM aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations
WHERE region = '{{ region }}' -- required
AND `next-token` = '{{ next-token }}'
AND `max-results` = '{{ max-results }}'
;

INSERT examples

create_media_insights_pipeline_configuration

A structure that contains the static configurations for a media insights pipeline.

INSERT INTO aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations (
MediaInsightsPipelineConfigurationName,
ResourceAccessRoleArn,
RealTimeAlertConfiguration,
Elements,
Tags,
ClientRequestToken,
region
)
SELECT 
'{{ MediaInsightsPipelineConfigurationName }}' /* required */,
'{{ ResourceAccessRoleArn }}' /* required */,
'{{ RealTimeAlertConfiguration }}',
'{{ Elements }}' /* required */,
'{{ Tags }}',
'{{ ClientRequestToken }}',
'{{ region }}'
RETURNING
media_insights_pipeline_configuration
;

create_media_insights_pipeline

Creates a media insights pipeline.

INSERT INTO aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations (
MediaInsightsPipelineConfigurationArn,
KinesisVideoStreamSourceRuntimeConfiguration,
MediaInsightsRuntimeMetadata,
KinesisVideoStreamRecordingSourceRuntimeConfiguration,
S3RecordingSinkRuntimeConfiguration,
Tags,
ClientRequestToken,
region
)
SELECT 
'{{ MediaInsightsPipelineConfigurationArn }}' /* required */,
'{{ KinesisVideoStreamSourceRuntimeConfiguration }}',
'{{ MediaInsightsRuntimeMetadata }}',
'{{ KinesisVideoStreamRecordingSourceRuntimeConfiguration }}',
'{{ S3RecordingSinkRuntimeConfiguration }}',
'{{ Tags }}',
'{{ ClientRequestToken }}',
'{{ region }}'
RETURNING
media_insights_pipeline
;

Manifest

# Description fields are for documentation purposes
- name: media_insights_pipeline_configurations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the media_insights_pipeline_configurations resource.
  - name: MediaInsightsPipelineConfigurationName
    value: "{{ MediaInsightsPipelineConfigurationName }}"
  - name: ResourceAccessRoleArn
    value: "{{ ResourceAccessRoleArn }}"
  - name: RealTimeAlertConfiguration
    description: |
      A structure that contains the configuration settings for real-time alerts.
    value:
      Disabled: {{ Disabled }}
      Rules:
        - Type: "{{ Type }}"
          KeywordMatchConfiguration:
            RuleName: "{{ RuleName }}"
            Keywords:
              - "{{ Keywords }}"
            Negate: {{ Negate }}
          SentimentConfiguration:
            RuleName: "{{ RuleName }}"
            SentimentType: "{{ SentimentType }}"
            TimePeriod: {{ TimePeriod }}
          IssueDetectionConfiguration:
            RuleName: "{{ RuleName }}"
  - name: Elements
    value:
      - Type: "{{ Type }}"
        AmazonTranscribeCallAnalyticsProcessorConfiguration:
          LanguageCode: "{{ LanguageCode }}"
          VocabularyName: "{{ VocabularyName }}"
          VocabularyFilterName: "{{ VocabularyFilterName }}"
          VocabularyFilterMethod: "{{ VocabularyFilterMethod }}"
          LanguageModelName: "{{ LanguageModelName }}"
          EnablePartialResultsStabilization: {{ EnablePartialResultsStabilization }}
          PartialResultsStability: "{{ PartialResultsStability }}"
          ContentIdentificationType: "{{ ContentIdentificationType }}"
          ContentRedactionType: "{{ ContentRedactionType }}"
          PiiEntityTypes: "{{ PiiEntityTypes }}"
          FilterPartialResults: {{ FilterPartialResults }}
          PostCallAnalyticsSettings:
            OutputLocation: "{{ OutputLocation }}"
            DataAccessRoleArn: "{{ DataAccessRoleArn }}"
            ContentRedactionOutput: "{{ ContentRedactionOutput }}"
            OutputEncryptionKMSKeyId: "{{ OutputEncryptionKMSKeyId }}"
          CallAnalyticsStreamCategories:
            - "{{ CallAnalyticsStreamCategories }}"
        AmazonTranscribeProcessorConfiguration:
          LanguageCode: "{{ LanguageCode }}"
          VocabularyName: "{{ VocabularyName }}"
          VocabularyFilterName: "{{ VocabularyFilterName }}"
          VocabularyFilterMethod: "{{ VocabularyFilterMethod }}"
          ShowSpeakerLabel: {{ ShowSpeakerLabel }}
          EnablePartialResultsStabilization: {{ EnablePartialResultsStabilization }}
          PartialResultsStability: "{{ PartialResultsStability }}"
          ContentIdentificationType: "{{ ContentIdentificationType }}"
          ContentRedactionType: "{{ ContentRedactionType }}"
          PiiEntityTypes: "{{ PiiEntityTypes }}"
          LanguageModelName: "{{ LanguageModelName }}"
          FilterPartialResults: {{ FilterPartialResults }}
          IdentifyLanguage: {{ IdentifyLanguage }}
          IdentifyMultipleLanguages: {{ IdentifyMultipleLanguages }}
          LanguageOptions: "{{ LanguageOptions }}"
          PreferredLanguage: "{{ PreferredLanguage }}"
          VocabularyNames: "{{ VocabularyNames }}"
          VocabularyFilterNames: "{{ VocabularyFilterNames }}"
        KinesisDataStreamSinkConfiguration:
          InsightsTarget: "{{ InsightsTarget }}"
        S3RecordingSinkConfiguration:
          Destination: "{{ Destination }}"
          RecordingFileFormat: "{{ RecordingFileFormat }}"
        VoiceAnalyticsProcessorConfiguration:
          SpeakerSearchStatus: "{{ SpeakerSearchStatus }}"
          VoiceToneAnalysisStatus: "{{ VoiceToneAnalysisStatus }}"
        LambdaFunctionSinkConfiguration:
          InsightsTarget: "{{ InsightsTarget }}"
        SqsQueueSinkConfiguration:
          InsightsTarget: "{{ InsightsTarget }}"
        SnsTopicSinkConfiguration:
          InsightsTarget: "{{ InsightsTarget }}"
        VoiceEnhancementSinkConfiguration:
          Disabled: {{ Disabled }}
  - name: Tags
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
  - name: MediaInsightsPipelineConfigurationArn
    value: "{{ MediaInsightsPipelineConfigurationArn }}"
  - name: KinesisVideoStreamSourceRuntimeConfiguration
    description: |
      The runtime configuration settings for the Kinesis video stream source.
    value:
      Streams:
        - StreamArn: "{{ StreamArn }}"
          FragmentNumber: "{{ FragmentNumber }}"
          StreamChannelDefinition:
            NumberOfChannels: {{ NumberOfChannels }}
            ChannelDefinitions:
              - ChannelId: {{ ChannelId }}
                ParticipantRole: "{{ ParticipantRole }}"
      MediaEncoding: "{{ MediaEncoding }}"
      MediaSampleRate: {{ MediaSampleRate }}
  - name: MediaInsightsRuntimeMetadata
    value: "{{ MediaInsightsRuntimeMetadata }}"
  - name: KinesisVideoStreamRecordingSourceRuntimeConfiguration
    description: |
      A structure that contains the runtime settings for recording a Kinesis video stream.
    value:
      Streams:
        - StreamArn: "{{ StreamArn }}"
      FragmentSelector:
        FragmentSelectorType: "{{ FragmentSelectorType }}"
        TimestampRange:
          StartTimestamp: "{{ StartTimestamp }}"
          EndTimestamp: "{{ EndTimestamp }}"
  - name: S3RecordingSinkRuntimeConfiguration
    description: |
      A structure that holds the settings for transmitting media files to the Amazon S3 bucket. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.
    value:
      Destination: "{{ Destination }}"
      RecordingFileFormat: "{{ RecordingFileFormat }}"

UPDATE examples

update_media_insights_pipeline_configuration

Updates the media insights pipeline's configuration settings.

UPDATE aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations
SET 
ResourceAccessRoleArn = '{{ ResourceAccessRoleArn }}',
RealTimeAlertConfiguration = '{{ RealTimeAlertConfiguration }}',
Elements = '{{ Elements }}'
WHERE 
identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND ResourceAccessRoleArn = '{{ ResourceAccessRoleArn }}' --required
AND Elements = '{{ Elements }}' --required
RETURNING
media_insights_pipeline_configuration;

DELETE examples

delete_media_insights_pipeline_configuration

Deletes the specified configuration settings.

DELETE FROM aws.chime_sdk_media_pipelines.media_insights_pipeline_configurations
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
;