CfnMediaInsightsPipelineConfiguration
- class aws_cdk.aws_chime.CfnMediaInsightsPipelineConfiguration(scope, id, *, elements, media_insights_pipeline_configuration_name, resource_access_role_arn, real_time_alert_configuration=None, tags=None)
Bases:
CfnResourceResource Type definition for an Amazon Chime SDK Media Insights Pipeline Configuration.
- See:
- CloudformationResource:
AWS::Chime::MediaInsightsPipelineConfiguration
- ExampleMetadata:
fixture=_generated
Example:
from aws_cdk import CfnTag # The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime cfn_media_insights_pipeline_configuration = chime.CfnMediaInsightsPipelineConfiguration(self, "MyCfnMediaInsightsPipelineConfiguration", elements=[chime.CfnMediaInsightsPipelineConfiguration.MediaInsightsPipelineConfigurationElementProperty( type="type", # the properties below are optional amazon_transcribe_call_analytics_processor_configuration=chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeCallAnalyticsProcessorConfigurationProperty( language_code="languageCode", # the properties below are optional call_analytics_stream_categories=["callAnalyticsStreamCategories"], content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, language_model_name="languageModelName", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", post_call_analytics_settings=chime.CfnMediaInsightsPipelineConfiguration.PostCallAnalyticsSettingsProperty( data_access_role_arn="dataAccessRoleArn", output_location="outputLocation", # the properties below are optional content_redaction_output="contentRedactionOutput", output_encryption_kms_key_id="outputEncryptionKmsKeyId" ), vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_name="vocabularyName" ), amazon_transcribe_processor_configuration=chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeProcessorConfigurationProperty( content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, identify_language=False, identify_multiple_languages=False, language_code="languageCode", language_model_name="languageModelName", language_options="languageOptions", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", preferred_language="preferredLanguage", show_speaker_label=False, vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_filter_names="vocabularyFilterNames", vocabulary_name="vocabularyName", vocabulary_names="vocabularyNames" ), kinesis_data_stream_sink_configuration=chime.CfnMediaInsightsPipelineConfiguration.KinesisDataStreamSinkConfigurationProperty( insights_target="insightsTarget" ), s3_recording_sink_configuration=chime.CfnMediaInsightsPipelineConfiguration.S3RecordingSinkConfigurationProperty( destination="destination", recording_file_format="recordingFileFormat" ) )], media_insights_pipeline_configuration_name="mediaInsightsPipelineConfigurationName", resource_access_role_arn="resourceAccessRoleArn", # the properties below are optional real_time_alert_configuration=chime.CfnMediaInsightsPipelineConfiguration.RealTimeAlertConfigurationProperty( disabled=False, rules=[chime.CfnMediaInsightsPipelineConfiguration.RealTimeAlertRuleProperty( type="type", # the properties below are optional issue_detection_configuration=chime.CfnMediaInsightsPipelineConfiguration.IssueDetectionConfigurationProperty( rule_name="ruleName" ), keyword_match_configuration=chime.CfnMediaInsightsPipelineConfiguration.KeywordMatchConfigurationProperty( keywords=["keywords"], rule_name="ruleName", # the properties below are optional negate=False ), sentiment_configuration=chime.CfnMediaInsightsPipelineConfiguration.SentimentConfigurationProperty( rule_name="ruleName", sentiment_type="sentimentType", time_period=123 ) )] ), tags=[CfnTag( key="key", value="value" )] )
Create a new
AWS::Chime::MediaInsightsPipelineConfiguration.- Parameters:
scope (
Construct) – Scope in which this resource is defined.id (
str) – Construct identifier for this resource (unique in its scope).elements (
Union[IResolvable,Sequence[Union[IResolvable,MediaInsightsPipelineConfigurationElementProperty,Dict[str,Any]]]]) – The elements in the configuration.media_insights_pipeline_configuration_name (
str) – The name of the media insights pipeline configuration.resource_access_role_arn (
str) – The ARN of the role used by the service to access Amazon Web Services resources.real_time_alert_configuration (
Union[IResolvable,RealTimeAlertConfigurationProperty,Dict[str,Any],None])tags (
Optional[Sequence[Union[CfnTag,Dict[str,Any]]]]) – The tags associated with the configuration.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined).- Parameters:
path (
str) – The path of the value to delete.- Return type:
None
- add_dependency(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This method has been renamed to
addResourceDependencyto more clearly set it apart fromconstruct.node.addDependency. See the documentation of that function for more details.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_depends_on(target)
(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method has been renamed to
addResourceDependency, which makes it more clear that this method operates at a different level from the construct-levelconstruct.node.addDependency()mechanism.- Parameters:
target (
CfnResource)- Deprecated:
Use
addResourceDependencyinstead.- Stability:
deprecated
- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str)value (
Any)
- See:
- Return type:
None
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverrideor prefixpathwith “Properties.” (i.e.Properties.TopicName).If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal
.in the property name, prefix with a\. In most programming languages you will need to write this as"\\."because the\itself will need to be escaped.For example:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
valueargument toaddOverridewill not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.- Parameters:
path (
str) –The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (
Any) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value).- Parameters:
property_path (
str) – The path of the property.value (
Any) – The value.
- Return type:
None
- add_resource_dependency(target, reason=None)
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
This method only adds dependencies between L1 resources. If you are looking for a generic construct-to-construct dependency mechanism that works for all constructs including L2s, use
construct.node.addDependencyinstead.- Parameters:
target (
CfnResource)reason (
Optional[str])
- Return type:
None
- apply_cross_stack_reference_strength(strength)
Sets the cross-stack reference strength for this resource.
When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack’s context.
- Parameters:
strength (
ReferenceStrength) –The reference strength to use for this resource.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.
The resource can be deleted (
RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:- Parameters:
policy (
Optional[RemovalPolicy])apply_to_update_replace_policy (
Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.
- See:
- Return type:
None
- cfn_property_name(cdk_property_name)
- Parameters:
cdk_property_name (
str)- Return type:
Optional[str]
- get_att(attribute_name, type_hint=None)
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g.
resource.arn), but this can be used for future compatibility in case there is no generated attribute.- Parameters:
attribute_name (
str) – The name of the attribute.type_hint (
Optional[ResolutionTypeHint])
- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str)- See:
- Return type:
Any
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.
- inspect(inspector)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector) – tree inspector to collect and process attributes.- Return type:
None
- obtain_dependencies()
Retrieves an array of resources and stacks this resource depends on.
For resources depended on directly, returns the
CfnResourceobject. For dependencies on other stacks, returns theStackobject. The order of the array is not guaranteed.- Return type:
List[Union[Stack,CfnResource]]
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str) – The new logical ID to use for this stack element.- Return type:
None
- remove_dependency(target)
(deprecated) Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Deprecated:
Use
removeResourceDependencyinstead- Stability:
deprecated
- Return type:
None
- remove_resource_dependency(target)
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
- Parameters:
target (
CfnResource)- Return type:
None
- replace_dependency(target, new_target)
Replaces one dependency with another.
- Parameters:
target (
CfnResource) – The dependency to replace.new_target (
CfnResource) – The new dependency to add.
- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str- Returns:
a string representation of this resource
- with_(*mixins)
Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple
with()calls if subsequent mixins should apply to added constructs.- Parameters:
mixins (
IMixin)- Return type:
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::Chime::MediaInsightsPipelineConfiguration'
- attr_created_timestamp
The time at which the configuration was created.
- CloudformationAttribute:
CreatedTimestamp
- attr_media_insights_pipeline_configuration_arn
The ARN of the configuration.
- CloudformationAttribute:
MediaInsightsPipelineConfigurationArn
- attr_media_insights_pipeline_configuration_id
The unique identifier of the configuration.
- CloudformationAttribute:
MediaInsightsPipelineConfigurationId
- attr_updated_timestamp
The time at which the configuration was last updated.
- CloudformationAttribute:
UpdatedTimestamp
- cdk_tag_manager
Tag Manager which manages the tags for this resource.
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- elements
The elements in the configuration.
- env
- logical_id
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use
overrideLogicalId(newLogicalId).- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- media_insights_pipeline_configuration_name
The name of the media insights pipeline configuration.
- media_insights_pipeline_configuration_ref
A reference to a MediaInsightsPipelineConfiguration resource.
- node
The tree node.
- real_time_alert_configuration
- ref
Return a string that will be resolved to a CloudFormation
{ Ref }for this element.If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through
Lazy.any({ produce: resource.ref }).
- resource_access_role_arn
The ARN of the role used by the service to access Amazon Web Services resources.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- tags
The tags associated with the configuration.
Static Methods
- classmethod arn_for_media_insights_pipeline_configuration(resource)
- Parameters:
resource (
IMediaInsightsPipelineConfigurationRef)- Return type:
str
- classmethod is_cfn_element(x)
Returns
trueif a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceofto allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any)- Return type:
bool- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_media_insights_pipeline_configuration(x)
Checks whether the given object is a CfnMediaInsightsPipelineConfiguration.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_cfn_resource(x)
Check whether the given object is a CfnResource.
- Parameters:
x (
Any)- Return type:
bool
- classmethod is_construct(x)
Checks if
xis a construct.Use this method instead of
instanceofto properly detectConstructinstances, even when the construct library is symlinked.Explanation: in JavaScript, multiple copies of the
constructslibrary on disk are seen as independent, completely different libraries. As a consequence, the classConstructin each copy of theconstructslibrary is seen as a different class, and an instance of one class will not test asinstanceofthe other class.npm installwill not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of theconstructslibrary can be accidentally installed, andinstanceofwill behave unpredictably. It is safest to avoid usinginstanceof, and using this type-testing method instead.- Parameters:
x (
Any) – Any object.- Return type:
bool- Returns:
true if
xis an object created from a class which extendsConstruct.
AmazonTranscribeCallAnalyticsProcessorConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.AmazonTranscribeCallAnalyticsProcessorConfigurationProperty(*, language_code, call_analytics_stream_categories=None, content_identification_type=None, content_redaction_type=None, enable_partial_results_stabilization=None, filter_partial_results=None, language_model_name=None, partial_results_stability=None, pii_entity_types=None, post_call_analytics_settings=None, vocabulary_filter_method=None, vocabulary_filter_name=None, vocabulary_name=None)
Bases:
object- Parameters:
language_code (
str) – The language code in the configuration.call_analytics_stream_categories (
Optional[Sequence[str]]) – The categories to send to the insights target.content_identification_type (
Optional[str]) – Labels all PII identified in the transcript.content_redaction_type (
Optional[str]) – Redacts all PII identified in the transcript.enable_partial_results_stabilization (
Union[bool,IResolvable,None]) – Enables partial result stabilization.filter_partial_results (
Union[bool,IResolvable,None]) – If true, partial results are filtered out.language_model_name (
Optional[str]) – The name of the custom language model.partial_results_stability (
Optional[str]) – The level of stability for partial results.pii_entity_types (
Optional[str]) – The types of PII to redact.post_call_analytics_settings (
Union[IResolvable,PostCallAnalyticsSettingsProperty,Dict[str,Any],None])vocabulary_filter_method (
Optional[str]) – The vocabulary filtering method.vocabulary_filter_name (
Optional[str]) – The name of the custom vocabulary filter.vocabulary_name (
Optional[str]) – The name of the custom vocabulary.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime amazon_transcribe_call_analytics_processor_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeCallAnalyticsProcessorConfigurationProperty( language_code="languageCode", # the properties below are optional call_analytics_stream_categories=["callAnalyticsStreamCategories"], content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, language_model_name="languageModelName", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", post_call_analytics_settings=chime.CfnMediaInsightsPipelineConfiguration.PostCallAnalyticsSettingsProperty( data_access_role_arn="dataAccessRoleArn", output_location="outputLocation", # the properties below are optional content_redaction_output="contentRedactionOutput", output_encryption_kms_key_id="outputEncryptionKmsKeyId" ), vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_name="vocabularyName" )
Attributes
- call_analytics_stream_categories
The categories to send to the insights target.
- content_identification_type
Labels all PII identified in the transcript.
- content_redaction_type
Redacts all PII identified in the transcript.
- enable_partial_results_stabilization
Enables partial result stabilization.
- filter_partial_results
If true, partial results are filtered out.
- language_code
The language code in the configuration.
- language_model_name
The name of the custom language model.
- partial_results_stability
The level of stability for partial results.
- pii_entity_types
The types of PII to redact.
- post_call_analytics_settings
-
- Type:
see
- vocabulary_filter_method
The vocabulary filtering method.
- vocabulary_filter_name
The name of the custom vocabulary filter.
- vocabulary_name
The name of the custom vocabulary.
AmazonTranscribeProcessorConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.AmazonTranscribeProcessorConfigurationProperty(*, content_identification_type=None, content_redaction_type=None, enable_partial_results_stabilization=None, filter_partial_results=None, identify_language=None, identify_multiple_languages=None, language_code=None, language_model_name=None, language_options=None, partial_results_stability=None, pii_entity_types=None, preferred_language=None, show_speaker_label=None, vocabulary_filter_method=None, vocabulary_filter_name=None, vocabulary_filter_names=None, vocabulary_name=None, vocabulary_names=None)
Bases:
object- Parameters:
content_identification_type (
Optional[str]) – Labels all PII identified in the transcript.content_redaction_type (
Optional[str]) – Redacts all PII identified in the transcript.enable_partial_results_stabilization (
Union[bool,IResolvable,None]) – Enables partial result stabilization.filter_partial_results (
Union[bool,IResolvable,None]) – If true, partial results are filtered out.identify_language (
Union[bool,IResolvable,None]) – Turns language identification on or off.identify_multiple_languages (
Union[bool,IResolvable,None]) – Turns multiple language identification on or off.language_code (
Optional[str]) – The language code.language_model_name (
Optional[str]) – The name of the custom language model.language_options (
Optional[str]) – The language options for transcription.partial_results_stability (
Optional[str]) – The level of stability for partial results.pii_entity_types (
Optional[str]) – The types of PII to redact.preferred_language (
Optional[str]) – The preferred language for transcription.show_speaker_label (
Union[bool,IResolvable,None]) – Enables speaker partitioning.vocabulary_filter_method (
Optional[str]) – The vocabulary filtering method.vocabulary_filter_name (
Optional[str]) – The name of the custom vocabulary filter.vocabulary_filter_names (
Optional[str]) – The names of the custom vocabulary filters.vocabulary_name (
Optional[str]) – The name of the custom vocabulary.vocabulary_names (
Optional[str]) – The names of the custom vocabularies.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime amazon_transcribe_processor_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeProcessorConfigurationProperty( content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, identify_language=False, identify_multiple_languages=False, language_code="languageCode", language_model_name="languageModelName", language_options="languageOptions", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", preferred_language="preferredLanguage", show_speaker_label=False, vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_filter_names="vocabularyFilterNames", vocabulary_name="vocabularyName", vocabulary_names="vocabularyNames" )
Attributes
- content_identification_type
Labels all PII identified in the transcript.
- content_redaction_type
Redacts all PII identified in the transcript.
- enable_partial_results_stabilization
Enables partial result stabilization.
- filter_partial_results
If true, partial results are filtered out.
- identify_language
Turns language identification on or off.
- identify_multiple_languages
Turns multiple language identification on or off.
- language_code
The language code.
- language_model_name
The name of the custom language model.
- language_options
The language options for transcription.
- partial_results_stability
The level of stability for partial results.
- pii_entity_types
The types of PII to redact.
- preferred_language
The preferred language for transcription.
- show_speaker_label
Enables speaker partitioning.
- vocabulary_filter_method
The vocabulary filtering method.
- vocabulary_filter_name
The name of the custom vocabulary filter.
- vocabulary_filter_names
The names of the custom vocabulary filters.
- vocabulary_name
The name of the custom vocabulary.
- vocabulary_names
The names of the custom vocabularies.
IssueDetectionConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.IssueDetectionConfigurationProperty(*, rule_name)
Bases:
object- Parameters:
rule_name (
str) – The name of the issue detection rule.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime issue_detection_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.IssueDetectionConfigurationProperty( rule_name="ruleName" )
Attributes
KeywordMatchConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.KeywordMatchConfigurationProperty(*, keywords, rule_name, negate=None)
Bases:
object- Parameters:
keywords (
Sequence[str]) – The keywords or phrases to match.rule_name (
str) – The name of the keyword match rule.negate (
Union[bool,IResolvable,None]) – Matches keywords on their presence or absence.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime keyword_match_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.KeywordMatchConfigurationProperty( keywords=["keywords"], rule_name="ruleName", # the properties below are optional negate=False )
Attributes
- keywords
The keywords or phrases to match.
- negate
Matches keywords on their presence or absence.
KinesisDataStreamSinkConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.KinesisDataStreamSinkConfigurationProperty(*, insights_target=None)
Bases:
object- Parameters:
insights_target (
Optional[str]) – The ARN of the Kinesis Data Stream sink.- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime kinesis_data_stream_sink_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.KinesisDataStreamSinkConfigurationProperty( insights_target="insightsTarget" )
Attributes
- insights_target
The ARN of the Kinesis Data Stream sink.
MediaInsightsPipelineConfigurationElementProperty
- class CfnMediaInsightsPipelineConfiguration.MediaInsightsPipelineConfigurationElementProperty(*, type, amazon_transcribe_call_analytics_processor_configuration=None, amazon_transcribe_processor_configuration=None, kinesis_data_stream_sink_configuration=None, s3_recording_sink_configuration=None)
Bases:
object- Parameters:
type (
str) – The element type.amazon_transcribe_call_analytics_processor_configuration (
Union[IResolvable,AmazonTranscribeCallAnalyticsProcessorConfigurationProperty,Dict[str,Any],None])amazon_transcribe_processor_configuration (
Union[IResolvable,AmazonTranscribeProcessorConfigurationProperty,Dict[str,Any],None])kinesis_data_stream_sink_configuration (
Union[IResolvable,KinesisDataStreamSinkConfigurationProperty,Dict[str,Any],None])s3_recording_sink_configuration (
Union[IResolvable,S3RecordingSinkConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime media_insights_pipeline_configuration_element_property = chime.CfnMediaInsightsPipelineConfiguration.MediaInsightsPipelineConfigurationElementProperty( type="type", # the properties below are optional amazon_transcribe_call_analytics_processor_configuration=chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeCallAnalyticsProcessorConfigurationProperty( language_code="languageCode", # the properties below are optional call_analytics_stream_categories=["callAnalyticsStreamCategories"], content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, language_model_name="languageModelName", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", post_call_analytics_settings=chime.CfnMediaInsightsPipelineConfiguration.PostCallAnalyticsSettingsProperty( data_access_role_arn="dataAccessRoleArn", output_location="outputLocation", # the properties below are optional content_redaction_output="contentRedactionOutput", output_encryption_kms_key_id="outputEncryptionKmsKeyId" ), vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_name="vocabularyName" ), amazon_transcribe_processor_configuration=chime.CfnMediaInsightsPipelineConfiguration.AmazonTranscribeProcessorConfigurationProperty( content_identification_type="contentIdentificationType", content_redaction_type="contentRedactionType", enable_partial_results_stabilization=False, filter_partial_results=False, identify_language=False, identify_multiple_languages=False, language_code="languageCode", language_model_name="languageModelName", language_options="languageOptions", partial_results_stability="partialResultsStability", pii_entity_types="piiEntityTypes", preferred_language="preferredLanguage", show_speaker_label=False, vocabulary_filter_method="vocabularyFilterMethod", vocabulary_filter_name="vocabularyFilterName", vocabulary_filter_names="vocabularyFilterNames", vocabulary_name="vocabularyName", vocabulary_names="vocabularyNames" ), kinesis_data_stream_sink_configuration=chime.CfnMediaInsightsPipelineConfiguration.KinesisDataStreamSinkConfigurationProperty( insights_target="insightsTarget" ), s3_recording_sink_configuration=chime.CfnMediaInsightsPipelineConfiguration.S3RecordingSinkConfigurationProperty( destination="destination", recording_file_format="recordingFileFormat" ) )
Attributes
- amazon_transcribe_call_analytics_processor_configuration
-
- Type:
see
- amazon_transcribe_processor_configuration
-
- Type:
see
- kinesis_data_stream_sink_configuration
-
- Type:
see
- s3_recording_sink_configuration
-
- Type:
see
PostCallAnalyticsSettingsProperty
- class CfnMediaInsightsPipelineConfiguration.PostCallAnalyticsSettingsProperty(*, data_access_role_arn, output_location, content_redaction_output=None, output_encryption_kms_key_id=None)
Bases:
object- Parameters:
data_access_role_arn (
str) – The ARN of the role used by Transcribe to upload post-call analysis.output_location (
str) – The URL of the Amazon S3 bucket for post-call data.content_redaction_output (
Optional[str]) – The content redaction output settings.output_encryption_kms_key_id (
Optional[str]) – The ID of the KMS key used to encrypt the output.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime post_call_analytics_settings_property = chime.CfnMediaInsightsPipelineConfiguration.PostCallAnalyticsSettingsProperty( data_access_role_arn="dataAccessRoleArn", output_location="outputLocation", # the properties below are optional content_redaction_output="contentRedactionOutput", output_encryption_kms_key_id="outputEncryptionKmsKeyId" )
Attributes
- content_redaction_output
The content redaction output settings.
- data_access_role_arn
The ARN of the role used by Transcribe to upload post-call analysis.
- output_encryption_kms_key_id
The ID of the KMS key used to encrypt the output.
- output_location
The URL of the Amazon S3 bucket for post-call data.
RealTimeAlertConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.RealTimeAlertConfigurationProperty(*, disabled=None, rules=None)
Bases:
object- Parameters:
disabled (
Union[bool,IResolvable,None]) – Turns off real-time alerts.rules (
Union[IResolvable,Sequence[Union[IResolvable,RealTimeAlertRuleProperty,Dict[str,Any]]],None]) – The rules in the alert.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime real_time_alert_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.RealTimeAlertConfigurationProperty( disabled=False, rules=[chime.CfnMediaInsightsPipelineConfiguration.RealTimeAlertRuleProperty( type="type", # the properties below are optional issue_detection_configuration=chime.CfnMediaInsightsPipelineConfiguration.IssueDetectionConfigurationProperty( rule_name="ruleName" ), keyword_match_configuration=chime.CfnMediaInsightsPipelineConfiguration.KeywordMatchConfigurationProperty( keywords=["keywords"], rule_name="ruleName", # the properties below are optional negate=False ), sentiment_configuration=chime.CfnMediaInsightsPipelineConfiguration.SentimentConfigurationProperty( rule_name="ruleName", sentiment_type="sentimentType", time_period=123 ) )] )
Attributes
- disabled
Turns off real-time alerts.
RealTimeAlertRuleProperty
- class CfnMediaInsightsPipelineConfiguration.RealTimeAlertRuleProperty(*, type, issue_detection_configuration=None, keyword_match_configuration=None, sentiment_configuration=None)
Bases:
object- Parameters:
type (
str) – The type of alert rule.issue_detection_configuration (
Union[IResolvable,IssueDetectionConfigurationProperty,Dict[str,Any],None])keyword_match_configuration (
Union[IResolvable,KeywordMatchConfigurationProperty,Dict[str,Any],None])sentiment_configuration (
Union[IResolvable,SentimentConfigurationProperty,Dict[str,Any],None])
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime real_time_alert_rule_property = chime.CfnMediaInsightsPipelineConfiguration.RealTimeAlertRuleProperty( type="type", # the properties below are optional issue_detection_configuration=chime.CfnMediaInsightsPipelineConfiguration.IssueDetectionConfigurationProperty( rule_name="ruleName" ), keyword_match_configuration=chime.CfnMediaInsightsPipelineConfiguration.KeywordMatchConfigurationProperty( keywords=["keywords"], rule_name="ruleName", # the properties below are optional negate=False ), sentiment_configuration=chime.CfnMediaInsightsPipelineConfiguration.SentimentConfigurationProperty( rule_name="ruleName", sentiment_type="sentimentType", time_period=123 ) )
Attributes
- issue_detection_configuration
-
- Type:
see
- keyword_match_configuration
-
- Type:
see
- sentiment_configuration
-
- Type:
see
S3RecordingSinkConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.S3RecordingSinkConfigurationProperty(*, destination=None, recording_file_format=None)
Bases:
object- Parameters:
destination (
Optional[str]) – The default URI of the Amazon S3 bucket.recording_file_format (
Optional[str]) – The recording file format.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime s3_recording_sink_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.S3RecordingSinkConfigurationProperty( destination="destination", recording_file_format="recordingFileFormat" )
Attributes
- destination
The default URI of the Amazon S3 bucket.
- recording_file_format
The recording file format.
SentimentConfigurationProperty
- class CfnMediaInsightsPipelineConfiguration.SentimentConfigurationProperty(*, rule_name, sentiment_type, time_period)
Bases:
object- Parameters:
rule_name (
str) – The name of the sentiment rule.sentiment_type (
str) – The type of sentiment.time_period (
Union[int,float]) – The analysis interval in seconds.
- See:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_chime as chime sentiment_configuration_property = chime.CfnMediaInsightsPipelineConfiguration.SentimentConfigurationProperty( rule_name="ruleName", sentiment_type="sentimentType", time_period=123 )
Attributes
- rule_name
The name of the sentiment rule.
- sentiment_type
The type of sentiment.