SDK for PHP 3.x

Client: Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient
Service ID: chime-sdk-media-pipelines
Version: 2021-07-15

This page describes the parameters and results for the operations of the Amazon Chime SDK Media Pipelines (2021-07-15), and shows how to use the Aws\ChimeSDKMediaPipelines\ChimeSDKMediaPipelinesClient object to call the described operations. This documentation is specific to the 2021-07-15 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CreateMediaCapturePipeline ( array $params = [] )
Creates a media pipeline.
CreateMediaConcatenationPipeline ( array $params = [] )
Creates a media concatenation pipeline.
CreateMediaInsightsPipeline ( array $params = [] )
Creates a media insights pipeline.
CreateMediaInsightsPipelineConfiguration ( array $params = [] )
A structure that contains the static configurations for a media insights pipeline.
CreateMediaLiveConnectorPipeline ( array $params = [] )
Creates a media live connector pipeline in an Amazon Chime SDK meeting.
CreateMediaPipelineKinesisVideoStreamPool ( array $params = [] )
Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.
CreateMediaStreamPipeline ( array $params = [] )
Creates a streaming media pipeline.
DeleteMediaCapturePipeline ( array $params = [] )
Deletes the media pipeline.
DeleteMediaInsightsPipelineConfiguration ( array $params = [] )
Deletes the specified configuration settings.
DeleteMediaPipeline ( array $params = [] )
Deletes the media pipeline.
DeleteMediaPipelineKinesisVideoStreamPool ( array $params = [] )
Deletes an Amazon Kinesis Video Stream pool.
GetMediaCapturePipeline ( array $params = [] )
Gets an existing media pipeline.
GetMediaInsightsPipelineConfiguration ( array $params = [] )
Gets the configuration settings for a media insights pipeline.
GetMediaPipeline ( array $params = [] )
Gets an existing media pipeline.
GetMediaPipelineKinesisVideoStreamPool ( array $params = [] )
Gets an Kinesis video stream pool.
GetSpeakerSearchTask ( array $params = [] )
Retrieves the details of the specified speaker search task.
GetVoiceToneAnalysisTask ( array $params = [] )
Retrieves the details of a voice tone analysis task.
ListMediaCapturePipelines ( array $params = [] )
Returns a list of media pipelines.
ListMediaInsightsPipelineConfigurations ( array $params = [] )
Lists the available media insights pipeline configurations.
ListMediaPipelineKinesisVideoStreamPools ( array $params = [] )
Lists the video stream pools in the media pipeline.
ListMediaPipelines ( array $params = [] )
Returns a list of media pipelines.
ListTagsForResource ( array $params = [] )
Lists the tags available for a media pipeline.
StartSpeakerSearchTask ( array $params = [] )
Starts a speaker search task.
StartVoiceToneAnalysisTask ( array $params = [] )
Starts a voice tone analysis task.
StopSpeakerSearchTask ( array $params = [] )
Stops a speaker search task.
StopVoiceToneAnalysisTask ( array $params = [] )
Stops a voice tone analysis task.
TagResource ( array $params = [] )
The ARN of the media pipeline that you want to tag.
UntagResource ( array $params = [] )
Removes any tags from a media pipeline.
UpdateMediaInsightsPipelineConfiguration ( array $params = [] )
Updates the media insights pipeline's configuration settings.
UpdateMediaInsightsPipelineStatus ( array $params = [] )
Updates the status of a media insights pipeline.
UpdateMediaPipelineKinesisVideoStreamPool ( array $params = [] )
Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListMediaCapturePipelines
ListMediaInsightsPipelineConfigurations
ListMediaPipelineKinesisVideoStreamPools
ListMediaPipelines

Operations

CreateMediaCapturePipeline

$result = $client->createMediaCapturePipeline([/* ... */]);
$promise = $client->createMediaCapturePipelineAsync([/* ... */]);

Creates a media pipeline.

Parameter Syntax

$result = $client->createMediaCapturePipeline([
    'ChimeSdkMeetingConfiguration' => [
        'ArtifactsConfiguration' => [
            'Audio' => [ // REQUIRED
                'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo|AudioWithCompositedVideo', // REQUIRED
            ],
            'CompositedVideo' => [
                'GridViewConfiguration' => [ // REQUIRED
                    'ActiveSpeakerOnlyConfiguration' => [
                        'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                    ],
                    'CanvasOrientation' => 'Landscape|Portrait',
                    'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly', // REQUIRED
                    'HorizontalLayoutConfiguration' => [
                        'TileAspectRatio' => '<string>',
                        'TileCount' => <integer>,
                        'TileOrder' => 'JoinSequence|SpeakerSequence',
                        'TilePosition' => 'Top|Bottom',
                    ],
                    'PresenterOnlyConfiguration' => [
                        'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                    ],
                    'VerticalLayoutConfiguration' => [
                        'TileAspectRatio' => '<string>',
                        'TileCount' => <integer>,
                        'TileOrder' => 'JoinSequence|SpeakerSequence',
                        'TilePosition' => 'Left|Right',
                    ],
                    'VideoAttribute' => [
                        'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                        'BorderThickness' => <integer>,
                        'CornerRadius' => <integer>,
                        'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                    ],
                ],
                'Layout' => 'GridView',
                'Resolution' => 'HD|FHD',
            ],
            'Content' => [ // REQUIRED
                'MuxType' => 'ContentOnly',
                'State' => 'Enabled|Disabled', // REQUIRED
            ],
            'Video' => [ // REQUIRED
                'MuxType' => 'VideoOnly',
                'State' => 'Enabled|Disabled', // REQUIRED
            ],
        ],
        'SourceConfiguration' => [
            'SelectedVideoStreams' => [
                'AttendeeIds' => ['<string>', ...],
                'ExternalUserIds' => ['<string>', ...],
            ],
        ],
    ],
    'ClientRequestToken' => '<string>',
    'SinkArn' => '<string>', // REQUIRED
    'SinkType' => 'S3Bucket', // REQUIRED
    'SourceArn' => '<string>', // REQUIRED
    'SourceType' => 'ChimeSdkMeeting', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ChimeSdkMeetingConfiguration

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

ClientRequestToken
Type: string

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media pipeline request.

SinkArn
Required: Yes
Type: string

The ARN of the sink type.

SinkType
Required: Yes
Type: string

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

SourceArn
Required: Yes
Type: string

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

SourceType
Required: Yes
Type: string

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

Tags
Type: Array of Tag structures

The tag key-value pairs.

Result Syntax

[
    'MediaCapturePipeline' => [
        'ChimeSdkMeetingConfiguration' => [
            'ArtifactsConfiguration' => [
                'Audio' => [
                    'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo|AudioWithCompositedVideo',
                ],
                'CompositedVideo' => [
                    'GridViewConfiguration' => [
                        'ActiveSpeakerOnlyConfiguration' => [
                            'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'CanvasOrientation' => 'Landscape|Portrait',
                        'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly',
                        'HorizontalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Top|Bottom',
                        ],
                        'PresenterOnlyConfiguration' => [
                            'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'VerticalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Left|Right',
                        ],
                        'VideoAttribute' => [
                            'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                            'BorderThickness' => <integer>,
                            'CornerRadius' => <integer>,
                            'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                        ],
                    ],
                    'Layout' => 'GridView',
                    'Resolution' => 'HD|FHD',
                ],
                'Content' => [
                    'MuxType' => 'ContentOnly',
                    'State' => 'Enabled|Disabled',
                ],
                'Video' => [
                    'MuxType' => 'VideoOnly',
                    'State' => 'Enabled|Disabled',
                ],
            ],
            'SourceConfiguration' => [
                'SelectedVideoStreams' => [
                    'AttendeeIds' => ['<string>', ...],
                    'ExternalUserIds' => ['<string>', ...],
                ],
            ],
        ],
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'SinkArn' => '<string>',
        'SinkType' => 'S3Bucket',
        'SourceArn' => '<string>',
        'SourceType' => 'ChimeSdkMeeting',
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaCapturePipeline
Type: MediaCapturePipeline structure

A media pipeline object, the ID, source type, source ARN, sink type, and sink ARN of a media pipeline object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaConcatenationPipeline

$result = $client->createMediaConcatenationPipeline([/* ... */]);
$promise = $client->createMediaConcatenationPipelineAsync([/* ... */]);

Creates a media concatenation pipeline.

Parameter Syntax

$result = $client->createMediaConcatenationPipeline([
    'ClientRequestToken' => '<string>',
    'Sinks' => [ // REQUIRED
        [
            'S3BucketSinkConfiguration' => [ // REQUIRED
                'Destination' => '<string>', // REQUIRED
            ],
            'Type' => 'S3Bucket', // REQUIRED
        ],
        // ...
    ],
    'Sources' => [ // REQUIRED
        [
            'MediaCapturePipelineSourceConfiguration' => [ // REQUIRED
                'ChimeSdkMeetingConfiguration' => [ // REQUIRED
                    'ArtifactsConfiguration' => [ // REQUIRED
                        'Audio' => [ // REQUIRED
                            'State' => 'Enabled', // REQUIRED
                        ],
                        'CompositedVideo' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                        'Content' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                        'DataChannel' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                        'MeetingEvents' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                        'TranscriptionMessages' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                        'Video' => [ // REQUIRED
                            'State' => 'Enabled|Disabled', // REQUIRED
                        ],
                    ],
                ],
                'MediaPipelineArn' => '<string>', // REQUIRED
            ],
            'Type' => 'MediaCapturePipeline', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the client request. The token makes the API request idempotent. Use a unique token for each media concatenation pipeline request.

Sinks
Required: Yes
Type: Array of ConcatenationSink structures

An object that specifies the data sinks for the media concatenation pipeline.

Sources
Required: Yes
Type: Array of ConcatenationSource structures

An object that specifies the sources for the media concatenation pipeline.

Tags
Type: Array of Tag structures

The tags associated with the media concatenation pipeline.

Result Syntax

[
    'MediaConcatenationPipeline' => [
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'Sinks' => [
            [
                'S3BucketSinkConfiguration' => [
                    'Destination' => '<string>',
                ],
                'Type' => 'S3Bucket',
            ],
            // ...
        ],
        'Sources' => [
            [
                'MediaCapturePipelineSourceConfiguration' => [
                    'ChimeSdkMeetingConfiguration' => [
                        'ArtifactsConfiguration' => [
                            'Audio' => [
                                'State' => 'Enabled',
                            ],
                            'CompositedVideo' => [
                                'State' => 'Enabled|Disabled',
                            ],
                            'Content' => [
                                'State' => 'Enabled|Disabled',
                            ],
                            'DataChannel' => [
                                'State' => 'Enabled|Disabled',
                            ],
                            'MeetingEvents' => [
                                'State' => 'Enabled|Disabled',
                            ],
                            'TranscriptionMessages' => [
                                'State' => 'Enabled|Disabled',
                            ],
                            'Video' => [
                                'State' => 'Enabled|Disabled',
                            ],
                        ],
                    ],
                    'MediaPipelineArn' => '<string>',
                ],
                'Type' => 'MediaCapturePipeline',
            ],
            // ...
        ],
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaConcatenationPipeline
Type: MediaConcatenationPipeline structure

A media concatenation pipeline object, the ID, source type, MediaPipelineARN, and sink of a media concatenation pipeline object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaInsightsPipeline

$result = $client->createMediaInsightsPipeline([/* ... */]);
$promise = $client->createMediaInsightsPipelineAsync([/* ... */]);

Creates a media insights pipeline.

Parameter Syntax

$result = $client->createMediaInsightsPipeline([
    'ClientRequestToken' => '<string>',
    'KinesisVideoStreamRecordingSourceRuntimeConfiguration' => [
        'FragmentSelector' => [ // REQUIRED
            'FragmentSelectorType' => 'ProducerTimestamp|ServerTimestamp', // REQUIRED
            'TimestampRange' => [ // REQUIRED
                'EndTimestamp' => <integer || string || DateTime>, // REQUIRED
                'StartTimestamp' => <integer || string || DateTime>, // REQUIRED
            ],
        ],
        'Streams' => [ // REQUIRED
            [
                'StreamArn' => '<string>',
            ],
            // ...
        ],
    ],
    'KinesisVideoStreamSourceRuntimeConfiguration' => [
        'MediaEncoding' => 'pcm', // REQUIRED
        'MediaSampleRate' => <integer>, // REQUIRED
        'Streams' => [ // REQUIRED
            [
                'FragmentNumber' => '<string>',
                'StreamArn' => '<string>', // REQUIRED
                'StreamChannelDefinition' => [ // REQUIRED
                    'ChannelDefinitions' => [
                        [
                            'ChannelId' => <integer>, // REQUIRED
                            'ParticipantRole' => 'AGENT|CUSTOMER',
                        ],
                        // ...
                    ],
                    'NumberOfChannels' => <integer>, // REQUIRED
                ],
            ],
            // ...
        ],
    ],
    'MediaInsightsPipelineConfigurationArn' => '<string>', // REQUIRED
    'MediaInsightsRuntimeMetadata' => ['<string>', ...],
    'S3RecordingSinkRuntimeConfiguration' => [
        'Destination' => '<string>', // REQUIRED
        'RecordingFileFormat' => 'Wav|Opus', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the media insights pipeline request.

KinesisVideoStreamRecordingSourceRuntimeConfiguration

The runtime configuration for the Kinesis video recording stream source.

KinesisVideoStreamSourceRuntimeConfiguration

The runtime configuration for the Kinesis video stream source of the media insights pipeline.

MediaInsightsPipelineConfigurationArn
Required: Yes
Type: string

The ARN of the pipeline's configuration.

MediaInsightsRuntimeMetadata
Type: Associative array of custom strings keys (NonEmptyString) to strings

The runtime metadata for the media insights pipeline. Consists of a key-value map of strings.

S3RecordingSinkRuntimeConfiguration

The runtime configuration for the S3 recording sink. If specified, the settings in this structure override any settings in S3RecordingSinkConfiguration.

Tags
Type: Array of Tag structures

The tags assigned to the media insights pipeline.

Result Syntax

[
    'MediaInsightsPipeline' => [
        'CreatedTimestamp' => <DateTime>,
        'ElementStatuses' => [
            [
                'Status' => 'NotStarted|NotSupported|Initializing|InProgress|Failed|Stopping|Stopped|Paused',
                'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink',
            ],
            // ...
        ],
        'KinesisVideoStreamRecordingSourceRuntimeConfiguration' => [
            'FragmentSelector' => [
                'FragmentSelectorType' => 'ProducerTimestamp|ServerTimestamp',
                'TimestampRange' => [
                    'EndTimestamp' => <DateTime>,
                    'StartTimestamp' => <DateTime>,
                ],
            ],
            'Streams' => [
                [
                    'StreamArn' => '<string>',
                ],
                // ...
            ],
        ],
        'KinesisVideoStreamSourceRuntimeConfiguration' => [
            'MediaEncoding' => 'pcm',
            'MediaSampleRate' => <integer>,
            'Streams' => [
                [
                    'FragmentNumber' => '<string>',
                    'StreamArn' => '<string>',
                    'StreamChannelDefinition' => [
                        'ChannelDefinitions' => [
                            [
                                'ChannelId' => <integer>,
                                'ParticipantRole' => 'AGENT|CUSTOMER',
                            ],
                            // ...
                        ],
                        'NumberOfChannels' => <integer>,
                    ],
                ],
                // ...
            ],
        ],
        'MediaInsightsPipelineConfigurationArn' => '<string>',
        'MediaInsightsRuntimeMetadata' => ['<string>', ...],
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'S3RecordingSinkRuntimeConfiguration' => [
            'Destination' => '<string>',
            'RecordingFileFormat' => 'Wav|Opus',
        ],
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
    ],
]

Result Details

Members
MediaInsightsPipeline
Required: Yes
Type: MediaInsightsPipeline structure

The media insights pipeline object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaInsightsPipelineConfiguration

$result = $client->createMediaInsightsPipelineConfiguration([/* ... */]);
$promise = $client->createMediaInsightsPipelineConfigurationAsync([/* ... */]);

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

Parameter Syntax

$result = $client->createMediaInsightsPipelineConfiguration([
    'ClientRequestToken' => '<string>',
    'Elements' => [ // REQUIRED
        [
            'AmazonTranscribeCallAnalyticsProcessorConfiguration' => [
                'CallAnalyticsStreamCategories' => ['<string>', ...],
                'ContentIdentificationType' => 'PII',
                'ContentRedactionType' => 'PII',
                'EnablePartialResultsStabilization' => true || false,
                'FilterPartialResults' => true || false,
                'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR', // REQUIRED
                'LanguageModelName' => '<string>',
                'PartialResultsStability' => 'high|medium|low',
                'PiiEntityTypes' => '<string>',
                'PostCallAnalyticsSettings' => [
                    'ContentRedactionOutput' => 'redacted|redacted_and_unredacted',
                    'DataAccessRoleArn' => '<string>', // REQUIRED
                    'OutputEncryptionKMSKeyId' => '<string>',
                    'OutputLocation' => '<string>', // REQUIRED
                ],
                'VocabularyFilterMethod' => 'remove|mask|tag',
                'VocabularyFilterName' => '<string>',
                'VocabularyName' => '<string>',
            ],
            'AmazonTranscribeProcessorConfiguration' => [
                'ContentIdentificationType' => 'PII',
                'ContentRedactionType' => 'PII',
                'EnablePartialResultsStabilization' => true || false,
                'FilterPartialResults' => true || false,
                'IdentifyLanguage' => true || false,
                'IdentifyMultipleLanguages' => true || false,
                'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                'LanguageModelName' => '<string>',
                'LanguageOptions' => '<string>',
                'PartialResultsStability' => 'high|medium|low',
                'PiiEntityTypes' => '<string>',
                'PreferredLanguage' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                'ShowSpeakerLabel' => true || false,
                'VocabularyFilterMethod' => 'remove|mask|tag',
                'VocabularyFilterName' => '<string>',
                'VocabularyFilterNames' => '<string>',
                'VocabularyName' => '<string>',
                'VocabularyNames' => '<string>',
            ],
            'KinesisDataStreamSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'LambdaFunctionSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'S3RecordingSinkConfiguration' => [
                'Destination' => '<string>',
                'RecordingFileFormat' => 'Wav|Opus',
            ],
            'SnsTopicSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'SqsQueueSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink', // REQUIRED
            'VoiceAnalyticsProcessorConfiguration' => [
                'SpeakerSearchStatus' => 'Enabled|Disabled',
                'VoiceToneAnalysisStatus' => 'Enabled|Disabled',
            ],
            'VoiceEnhancementSinkConfiguration' => [
                'Disabled' => true || false,
            ],
        ],
        // ...
    ],
    'MediaInsightsPipelineConfigurationName' => '<string>', // REQUIRED
    'RealTimeAlertConfiguration' => [
        'Disabled' => true || false,
        'Rules' => [
            [
                'IssueDetectionConfiguration' => [
                    'RuleName' => '<string>', // REQUIRED
                ],
                'KeywordMatchConfiguration' => [
                    'Keywords' => ['<string>', ...], // REQUIRED
                    'Negate' => true || false,
                    'RuleName' => '<string>', // REQUIRED
                ],
                'SentimentConfiguration' => [
                    'RuleName' => '<string>', // REQUIRED
                    'SentimentType' => 'NEGATIVE', // REQUIRED
                    'TimePeriod' => <integer>, // REQUIRED
                ],
                'Type' => 'KeywordMatch|Sentiment|IssueDetection', // REQUIRED
            ],
            // ...
        ],
    ],
    'ResourceAccessRoleArn' => '<string>', // REQUIRED
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the media insights pipeline configuration request.

Elements
Required: Yes
Type: Array of MediaInsightsPipelineConfigurationElement structures

The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream.

MediaInsightsPipelineConfigurationName
Required: Yes
Type: string

The name of the media insights pipeline configuration.

RealTimeAlertConfiguration
Type: RealTimeAlertConfiguration structure

The configuration settings for the real-time alerts in a media insights pipeline configuration.

ResourceAccessRoleArn
Required: Yes
Type: string

The ARN of the role used by the service to access Amazon Web Services resources, including Transcribe and Transcribe Call Analytics, on the caller’s behalf.

Tags
Type: Array of Tag structures

The tags assigned to the media insights pipeline configuration.

Result Syntax

[
    'MediaInsightsPipelineConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'Elements' => [
            [
                'AmazonTranscribeCallAnalyticsProcessorConfiguration' => [
                    'CallAnalyticsStreamCategories' => ['<string>', ...],
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PostCallAnalyticsSettings' => [
                        'ContentRedactionOutput' => 'redacted|redacted_and_unredacted',
                        'DataAccessRoleArn' => '<string>',
                        'OutputEncryptionKMSKeyId' => '<string>',
                        'OutputLocation' => '<string>',
                    ],
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyName' => '<string>',
                ],
                'AmazonTranscribeProcessorConfiguration' => [
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'IdentifyLanguage' => true || false,
                    'IdentifyMultipleLanguages' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'LanguageOptions' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PreferredLanguage' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'ShowSpeakerLabel' => true || false,
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyFilterNames' => '<string>',
                    'VocabularyName' => '<string>',
                    'VocabularyNames' => '<string>',
                ],
                'KinesisDataStreamSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'LambdaFunctionSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'S3RecordingSinkConfiguration' => [
                    'Destination' => '<string>',
                    'RecordingFileFormat' => 'Wav|Opus',
                ],
                'SnsTopicSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'SqsQueueSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink',
                'VoiceAnalyticsProcessorConfiguration' => [
                    'SpeakerSearchStatus' => 'Enabled|Disabled',
                    'VoiceToneAnalysisStatus' => 'Enabled|Disabled',
                ],
                'VoiceEnhancementSinkConfiguration' => [
                    'Disabled' => true || false,
                ],
            ],
            // ...
        ],
        'MediaInsightsPipelineConfigurationArn' => '<string>',
        'MediaInsightsPipelineConfigurationId' => '<string>',
        'MediaInsightsPipelineConfigurationName' => '<string>',
        'RealTimeAlertConfiguration' => [
            'Disabled' => true || false,
            'Rules' => [
                [
                    'IssueDetectionConfiguration' => [
                        'RuleName' => '<string>',
                    ],
                    'KeywordMatchConfiguration' => [
                        'Keywords' => ['<string>', ...],
                        'Negate' => true || false,
                        'RuleName' => '<string>',
                    ],
                    'SentimentConfiguration' => [
                        'RuleName' => '<string>',
                        'SentimentType' => 'NEGATIVE',
                        'TimePeriod' => <integer>,
                    ],
                    'Type' => 'KeywordMatch|Sentiment|IssueDetection',
                ],
                // ...
            ],
        ],
        'ResourceAccessRoleArn' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaInsightsPipelineConfiguration

The configuration settings for the media insights pipeline.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaLiveConnectorPipeline

$result = $client->createMediaLiveConnectorPipeline([/* ... */]);
$promise = $client->createMediaLiveConnectorPipelineAsync([/* ... */]);

Creates a media live connector pipeline in an Amazon Chime SDK meeting.

Parameter Syntax

$result = $client->createMediaLiveConnectorPipeline([
    'ClientRequestToken' => '<string>',
    'Sinks' => [ // REQUIRED
        [
            'RTMPConfiguration' => [ // REQUIRED
                'AudioChannels' => 'Stereo|Mono',
                'AudioSampleRate' => '<string>',
                'Url' => '<string>', // REQUIRED
            ],
            'SinkType' => 'RTMP', // REQUIRED
        ],
        // ...
    ],
    'Sources' => [ // REQUIRED
        [
            'ChimeSdkMeetingLiveConnectorConfiguration' => [ // REQUIRED
                'Arn' => '<string>', // REQUIRED
                'CompositedVideo' => [
                    'GridViewConfiguration' => [ // REQUIRED
                        'ActiveSpeakerOnlyConfiguration' => [
                            'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'CanvasOrientation' => 'Landscape|Portrait',
                        'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly', // REQUIRED
                        'HorizontalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Top|Bottom',
                        ],
                        'PresenterOnlyConfiguration' => [
                            'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'VerticalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Left|Right',
                        ],
                        'VideoAttribute' => [
                            'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                            'BorderThickness' => <integer>,
                            'CornerRadius' => <integer>,
                            'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                        ],
                    ],
                    'Layout' => 'GridView',
                    'Resolution' => 'HD|FHD',
                ],
                'MuxType' => 'AudioWithCompositedVideo|AudioWithActiveSpeakerVideo', // REQUIRED
                'SourceConfiguration' => [
                    'SelectedVideoStreams' => [
                        'AttendeeIds' => ['<string>', ...],
                        'ExternalUserIds' => ['<string>', ...],
                    ],
                ],
            ],
            'SourceType' => 'ChimeSdkMeeting', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The token assigned to the client making the request.

Sinks
Required: Yes
Type: Array of LiveConnectorSinkConfiguration structures

The media live connector pipeline's data sinks.

Sources
Required: Yes
Type: Array of LiveConnectorSourceConfiguration structures

The media live connector pipeline's data sources.

Tags
Type: Array of Tag structures

The tags associated with the media live connector pipeline.

Result Syntax

[
    'MediaLiveConnectorPipeline' => [
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'Sinks' => [
            [
                'RTMPConfiguration' => [
                    'AudioChannels' => 'Stereo|Mono',
                    'AudioSampleRate' => '<string>',
                    'Url' => '<string>',
                ],
                'SinkType' => 'RTMP',
            ],
            // ...
        ],
        'Sources' => [
            [
                'ChimeSdkMeetingLiveConnectorConfiguration' => [
                    'Arn' => '<string>',
                    'CompositedVideo' => [
                        'GridViewConfiguration' => [
                            'ActiveSpeakerOnlyConfiguration' => [
                                'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                            ],
                            'CanvasOrientation' => 'Landscape|Portrait',
                            'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly',
                            'HorizontalLayoutConfiguration' => [
                                'TileAspectRatio' => '<string>',
                                'TileCount' => <integer>,
                                'TileOrder' => 'JoinSequence|SpeakerSequence',
                                'TilePosition' => 'Top|Bottom',
                            ],
                            'PresenterOnlyConfiguration' => [
                                'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                            ],
                            'VerticalLayoutConfiguration' => [
                                'TileAspectRatio' => '<string>',
                                'TileCount' => <integer>,
                                'TileOrder' => 'JoinSequence|SpeakerSequence',
                                'TilePosition' => 'Left|Right',
                            ],
                            'VideoAttribute' => [
                                'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                                'BorderThickness' => <integer>,
                                'CornerRadius' => <integer>,
                                'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                            ],
                        ],
                        'Layout' => 'GridView',
                        'Resolution' => 'HD|FHD',
                    ],
                    'MuxType' => 'AudioWithCompositedVideo|AudioWithActiveSpeakerVideo',
                    'SourceConfiguration' => [
                        'SelectedVideoStreams' => [
                            'AttendeeIds' => ['<string>', ...],
                            'ExternalUserIds' => ['<string>', ...],
                        ],
                    ],
                ],
                'SourceType' => 'ChimeSdkMeeting',
            ],
            // ...
        ],
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaLiveConnectorPipeline
Type: MediaLiveConnectorPipeline structure

The new media live connector pipeline.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaPipelineKinesisVideoStreamPool

$result = $client->createMediaPipelineKinesisVideoStreamPool([/* ... */]);
$promise = $client->createMediaPipelineKinesisVideoStreamPoolAsync([/* ... */]);

Creates an Amazon Kinesis Video Stream pool for use with media stream pipelines.

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 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.

Parameter Syntax

$result = $client->createMediaPipelineKinesisVideoStreamPool([
    'ClientRequestToken' => '<string>',
    'PoolName' => '<string>', // REQUIRED
    'StreamConfiguration' => [ // REQUIRED
        'DataRetentionInHours' => <integer>,
        'Region' => '<string>', // REQUIRED
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The token assigned to the client making the request.

PoolName
Required: Yes
Type: string

The name of the pool.

StreamConfiguration
Required: Yes
Type: KinesisVideoStreamConfiguration structure

The configuration settings for the stream.

Tags
Type: Array of Tag structures

The tags assigned to the stream pool.

Result Syntax

[
    'KinesisVideoStreamPoolConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'PoolArn' => '<string>',
        'PoolId' => '<string>',
        'PoolName' => '<string>',
        'PoolSize' => <integer>,
        'PoolStatus' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
        'StreamConfiguration' => [
            'DataRetentionInHours' => <integer>,
            'Region' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
KinesisVideoStreamPoolConfiguration

The configuration for applying the streams to the pool.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

CreateMediaStreamPipeline

$result = $client->createMediaStreamPipeline([/* ... */]);
$promise = $client->createMediaStreamPipelineAsync([/* ... */]);

Creates a streaming media pipeline.

Parameter Syntax

$result = $client->createMediaStreamPipeline([
    'ClientRequestToken' => '<string>',
    'Sinks' => [ // REQUIRED
        [
            'MediaStreamType' => 'MixedAudio|IndividualAudio', // REQUIRED
            'ReservedStreamCapacity' => <integer>, // REQUIRED
            'SinkArn' => '<string>', // REQUIRED
            'SinkType' => 'KinesisVideoStreamPool', // REQUIRED
        ],
        // ...
    ],
    'Sources' => [ // REQUIRED
        [
            'SourceArn' => '<string>', // REQUIRED
            'SourceType' => 'ChimeSdkMeeting', // REQUIRED
        ],
        // ...
    ],
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ClientRequestToken
Type: string

The token assigned to the client making the request.

Sinks
Required: Yes
Type: Array of MediaStreamSink structures

The data sink for the media pipeline.

Sources
Required: Yes
Type: Array of MediaStreamSource structures

The data sources for the media pipeline.

Tags
Type: Array of Tag structures

The tags assigned to the media pipeline.

Result Syntax

[
    'MediaStreamPipeline' => [
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'Sinks' => [
            [
                'MediaStreamType' => 'MixedAudio|IndividualAudio',
                'ReservedStreamCapacity' => <integer>,
                'SinkArn' => '<string>',
                'SinkType' => 'KinesisVideoStreamPool',
            ],
            // ...
        ],
        'Sources' => [
            [
                'SourceArn' => '<string>',
                'SourceType' => 'ChimeSdkMeeting',
            ],
            // ...
        ],
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaStreamPipeline
Type: MediaStreamPipeline structure

The requested media pipeline.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMediaCapturePipeline

$result = $client->deleteMediaCapturePipeline([/* ... */]);
$promise = $client->deleteMediaCapturePipelineAsync([/* ... */]);

Deletes the media pipeline.

Parameter Syntax

$result = $client->deleteMediaCapturePipeline([
    'MediaPipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MediaPipelineId
Required: Yes
Type: string

The ID of the media pipeline being deleted.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMediaInsightsPipelineConfiguration

$result = $client->deleteMediaInsightsPipelineConfiguration([/* ... */]);
$promise = $client->deleteMediaInsightsPipelineConfigurationAsync([/* ... */]);

Deletes the specified configuration settings.

Parameter Syntax

$result = $client->deleteMediaInsightsPipelineConfiguration([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be deleted. Valid values include the name and ARN of the media insights pipeline configuration.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMediaPipeline

$result = $client->deleteMediaPipeline([/* ... */]);
$promise = $client->deleteMediaPipelineAsync([/* ... */]);

Deletes the media pipeline.

Parameter Syntax

$result = $client->deleteMediaPipeline([
    'MediaPipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MediaPipelineId
Required: Yes
Type: string

The ID of the media pipeline to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

DeleteMediaPipelineKinesisVideoStreamPool

$result = $client->deleteMediaPipelineKinesisVideoStreamPool([/* ... */]);
$promise = $client->deleteMediaPipelineKinesisVideoStreamPoolAsync([/* ... */]);

Deletes an Amazon Kinesis Video Stream pool.

Parameter Syntax

$result = $client->deleteMediaPipelineKinesisVideoStreamPool([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMediaCapturePipeline

$result = $client->getMediaCapturePipeline([/* ... */]);
$promise = $client->getMediaCapturePipelineAsync([/* ... */]);

Gets an existing media pipeline.

Parameter Syntax

$result = $client->getMediaCapturePipeline([
    'MediaPipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MediaPipelineId
Required: Yes
Type: string

The ID of the pipeline that you want to get.

Result Syntax

[
    'MediaCapturePipeline' => [
        'ChimeSdkMeetingConfiguration' => [
            'ArtifactsConfiguration' => [
                'Audio' => [
                    'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo|AudioWithCompositedVideo',
                ],
                'CompositedVideo' => [
                    'GridViewConfiguration' => [
                        'ActiveSpeakerOnlyConfiguration' => [
                            'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'CanvasOrientation' => 'Landscape|Portrait',
                        'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly',
                        'HorizontalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Top|Bottom',
                        ],
                        'PresenterOnlyConfiguration' => [
                            'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                        ],
                        'VerticalLayoutConfiguration' => [
                            'TileAspectRatio' => '<string>',
                            'TileCount' => <integer>,
                            'TileOrder' => 'JoinSequence|SpeakerSequence',
                            'TilePosition' => 'Left|Right',
                        ],
                        'VideoAttribute' => [
                            'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                            'BorderThickness' => <integer>,
                            'CornerRadius' => <integer>,
                            'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                        ],
                    ],
                    'Layout' => 'GridView',
                    'Resolution' => 'HD|FHD',
                ],
                'Content' => [
                    'MuxType' => 'ContentOnly',
                    'State' => 'Enabled|Disabled',
                ],
                'Video' => [
                    'MuxType' => 'VideoOnly',
                    'State' => 'Enabled|Disabled',
                ],
            ],
            'SourceConfiguration' => [
                'SelectedVideoStreams' => [
                    'AttendeeIds' => ['<string>', ...],
                    'ExternalUserIds' => ['<string>', ...],
                ],
            ],
        ],
        'CreatedTimestamp' => <DateTime>,
        'MediaPipelineArn' => '<string>',
        'MediaPipelineId' => '<string>',
        'SinkArn' => '<string>',
        'SinkType' => 'S3Bucket',
        'SourceArn' => '<string>',
        'SourceType' => 'ChimeSdkMeeting',
        'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaCapturePipeline
Type: MediaCapturePipeline structure

The media pipeline object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMediaInsightsPipelineConfiguration

$result = $client->getMediaInsightsPipelineConfiguration([/* ... */]);
$promise = $client->getMediaInsightsPipelineConfigurationAsync([/* ... */]);

Gets the configuration settings for a media insights pipeline.

Parameter Syntax

$result = $client->getMediaInsightsPipelineConfiguration([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the requested resource. Valid values include the name and ARN of the media insights pipeline configuration.

Result Syntax

[
    'MediaInsightsPipelineConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'Elements' => [
            [
                'AmazonTranscribeCallAnalyticsProcessorConfiguration' => [
                    'CallAnalyticsStreamCategories' => ['<string>', ...],
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PostCallAnalyticsSettings' => [
                        'ContentRedactionOutput' => 'redacted|redacted_and_unredacted',
                        'DataAccessRoleArn' => '<string>',
                        'OutputEncryptionKMSKeyId' => '<string>',
                        'OutputLocation' => '<string>',
                    ],
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyName' => '<string>',
                ],
                'AmazonTranscribeProcessorConfiguration' => [
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'IdentifyLanguage' => true || false,
                    'IdentifyMultipleLanguages' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'LanguageOptions' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PreferredLanguage' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'ShowSpeakerLabel' => true || false,
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyFilterNames' => '<string>',
                    'VocabularyName' => '<string>',
                    'VocabularyNames' => '<string>',
                ],
                'KinesisDataStreamSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'LambdaFunctionSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'S3RecordingSinkConfiguration' => [
                    'Destination' => '<string>',
                    'RecordingFileFormat' => 'Wav|Opus',
                ],
                'SnsTopicSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'SqsQueueSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink',
                'VoiceAnalyticsProcessorConfiguration' => [
                    'SpeakerSearchStatus' => 'Enabled|Disabled',
                    'VoiceToneAnalysisStatus' => 'Enabled|Disabled',
                ],
                'VoiceEnhancementSinkConfiguration' => [
                    'Disabled' => true || false,
                ],
            ],
            // ...
        ],
        'MediaInsightsPipelineConfigurationArn' => '<string>',
        'MediaInsightsPipelineConfigurationId' => '<string>',
        'MediaInsightsPipelineConfigurationName' => '<string>',
        'RealTimeAlertConfiguration' => [
            'Disabled' => true || false,
            'Rules' => [
                [
                    'IssueDetectionConfiguration' => [
                        'RuleName' => '<string>',
                    ],
                    'KeywordMatchConfiguration' => [
                        'Keywords' => ['<string>', ...],
                        'Negate' => true || false,
                        'RuleName' => '<string>',
                    ],
                    'SentimentConfiguration' => [
                        'RuleName' => '<string>',
                        'SentimentType' => 'NEGATIVE',
                        'TimePeriod' => <integer>,
                    ],
                    'Type' => 'KeywordMatch|Sentiment|IssueDetection',
                ],
                // ...
            ],
        ],
        'ResourceAccessRoleArn' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaInsightsPipelineConfiguration

The requested media insights pipeline configuration.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMediaPipeline

$result = $client->getMediaPipeline([/* ... */]);
$promise = $client->getMediaPipelineAsync([/* ... */]);

Gets an existing media pipeline.

Parameter Syntax

$result = $client->getMediaPipeline([
    'MediaPipelineId' => '<string>', // REQUIRED
]);

Parameter Details

Members
MediaPipelineId
Required: Yes
Type: string

The ID of the pipeline that you want to get.

Result Syntax

[
    'MediaPipeline' => [
        'MediaCapturePipeline' => [
            'ChimeSdkMeetingConfiguration' => [
                'ArtifactsConfiguration' => [
                    'Audio' => [
                        'MuxType' => 'AudioOnly|AudioWithActiveSpeakerVideo|AudioWithCompositedVideo',
                    ],
                    'CompositedVideo' => [
                        'GridViewConfiguration' => [
                            'ActiveSpeakerOnlyConfiguration' => [
                                'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                            ],
                            'CanvasOrientation' => 'Landscape|Portrait',
                            'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly',
                            'HorizontalLayoutConfiguration' => [
                                'TileAspectRatio' => '<string>',
                                'TileCount' => <integer>,
                                'TileOrder' => 'JoinSequence|SpeakerSequence',
                                'TilePosition' => 'Top|Bottom',
                            ],
                            'PresenterOnlyConfiguration' => [
                                'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                            ],
                            'VerticalLayoutConfiguration' => [
                                'TileAspectRatio' => '<string>',
                                'TileCount' => <integer>,
                                'TileOrder' => 'JoinSequence|SpeakerSequence',
                                'TilePosition' => 'Left|Right',
                            ],
                            'VideoAttribute' => [
                                'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                                'BorderThickness' => <integer>,
                                'CornerRadius' => <integer>,
                                'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                            ],
                        ],
                        'Layout' => 'GridView',
                        'Resolution' => 'HD|FHD',
                    ],
                    'Content' => [
                        'MuxType' => 'ContentOnly',
                        'State' => 'Enabled|Disabled',
                    ],
                    'Video' => [
                        'MuxType' => 'VideoOnly',
                        'State' => 'Enabled|Disabled',
                    ],
                ],
                'SourceConfiguration' => [
                    'SelectedVideoStreams' => [
                        'AttendeeIds' => ['<string>', ...],
                        'ExternalUserIds' => ['<string>', ...],
                    ],
                ],
            ],
            'CreatedTimestamp' => <DateTime>,
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
            'SinkArn' => '<string>',
            'SinkType' => 'S3Bucket',
            'SourceArn' => '<string>',
            'SourceType' => 'ChimeSdkMeeting',
            'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
            'UpdatedTimestamp' => <DateTime>,
        ],
        'MediaConcatenationPipeline' => [
            'CreatedTimestamp' => <DateTime>,
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
            'Sinks' => [
                [
                    'S3BucketSinkConfiguration' => [
                        'Destination' => '<string>',
                    ],
                    'Type' => 'S3Bucket',
                ],
                // ...
            ],
            'Sources' => [
                [
                    'MediaCapturePipelineSourceConfiguration' => [
                        'ChimeSdkMeetingConfiguration' => [
                            'ArtifactsConfiguration' => [
                                'Audio' => [
                                    'State' => 'Enabled',
                                ],
                                'CompositedVideo' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                                'Content' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                                'DataChannel' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                                'MeetingEvents' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                                'TranscriptionMessages' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                                'Video' => [
                                    'State' => 'Enabled|Disabled',
                                ],
                            ],
                        ],
                        'MediaPipelineArn' => '<string>',
                    ],
                    'Type' => 'MediaCapturePipeline',
                ],
                // ...
            ],
            'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
            'UpdatedTimestamp' => <DateTime>,
        ],
        'MediaInsightsPipeline' => [
            'CreatedTimestamp' => <DateTime>,
            'ElementStatuses' => [
                [
                    'Status' => 'NotStarted|NotSupported|Initializing|InProgress|Failed|Stopping|Stopped|Paused',
                    'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink',
                ],
                // ...
            ],
            'KinesisVideoStreamRecordingSourceRuntimeConfiguration' => [
                'FragmentSelector' => [
                    'FragmentSelectorType' => 'ProducerTimestamp|ServerTimestamp',
                    'TimestampRange' => [
                        'EndTimestamp' => <DateTime>,
                        'StartTimestamp' => <DateTime>,
                    ],
                ],
                'Streams' => [
                    [
                        'StreamArn' => '<string>',
                    ],
                    // ...
                ],
            ],
            'KinesisVideoStreamSourceRuntimeConfiguration' => [
                'MediaEncoding' => 'pcm',
                'MediaSampleRate' => <integer>,
                'Streams' => [
                    [
                        'FragmentNumber' => '<string>',
                        'StreamArn' => '<string>',
                        'StreamChannelDefinition' => [
                            'ChannelDefinitions' => [
                                [
                                    'ChannelId' => <integer>,
                                    'ParticipantRole' => 'AGENT|CUSTOMER',
                                ],
                                // ...
                            ],
                            'NumberOfChannels' => <integer>,
                        ],
                    ],
                    // ...
                ],
            ],
            'MediaInsightsPipelineConfigurationArn' => '<string>',
            'MediaInsightsRuntimeMetadata' => ['<string>', ...],
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
            'S3RecordingSinkRuntimeConfiguration' => [
                'Destination' => '<string>',
                'RecordingFileFormat' => 'Wav|Opus',
            ],
            'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
        ],
        'MediaLiveConnectorPipeline' => [
            'CreatedTimestamp' => <DateTime>,
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
            'Sinks' => [
                [
                    'RTMPConfiguration' => [
                        'AudioChannels' => 'Stereo|Mono',
                        'AudioSampleRate' => '<string>',
                        'Url' => '<string>',
                    ],
                    'SinkType' => 'RTMP',
                ],
                // ...
            ],
            'Sources' => [
                [
                    'ChimeSdkMeetingLiveConnectorConfiguration' => [
                        'Arn' => '<string>',
                        'CompositedVideo' => [
                            'GridViewConfiguration' => [
                                'ActiveSpeakerOnlyConfiguration' => [
                                    'ActiveSpeakerPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                                ],
                                'CanvasOrientation' => 'Landscape|Portrait',
                                'ContentShareLayout' => 'PresenterOnly|Horizontal|Vertical|ActiveSpeakerOnly',
                                'HorizontalLayoutConfiguration' => [
                                    'TileAspectRatio' => '<string>',
                                    'TileCount' => <integer>,
                                    'TileOrder' => 'JoinSequence|SpeakerSequence',
                                    'TilePosition' => 'Top|Bottom',
                                ],
                                'PresenterOnlyConfiguration' => [
                                    'PresenterPosition' => 'TopLeft|TopRight|BottomLeft|BottomRight',
                                ],
                                'VerticalLayoutConfiguration' => [
                                    'TileAspectRatio' => '<string>',
                                    'TileCount' => <integer>,
                                    'TileOrder' => 'JoinSequence|SpeakerSequence',
                                    'TilePosition' => 'Left|Right',
                                ],
                                'VideoAttribute' => [
                                    'BorderColor' => 'Black|Blue|Red|Green|White|Yellow',
                                    'BorderThickness' => <integer>,
                                    'CornerRadius' => <integer>,
                                    'HighlightColor' => 'Black|Blue|Red|Green|White|Yellow',
                                ],
                            ],
                            'Layout' => 'GridView',
                            'Resolution' => 'HD|FHD',
                        ],
                        'MuxType' => 'AudioWithCompositedVideo|AudioWithActiveSpeakerVideo',
                        'SourceConfiguration' => [
                            'SelectedVideoStreams' => [
                                'AttendeeIds' => ['<string>', ...],
                                'ExternalUserIds' => ['<string>', ...],
                            ],
                        ],
                    ],
                    'SourceType' => 'ChimeSdkMeeting',
                ],
                // ...
            ],
            'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
            'UpdatedTimestamp' => <DateTime>,
        ],
        'MediaStreamPipeline' => [
            'CreatedTimestamp' => <DateTime>,
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
            'Sinks' => [
                [
                    'MediaStreamType' => 'MixedAudio|IndividualAudio',
                    'ReservedStreamCapacity' => <integer>,
                    'SinkArn' => '<string>',
                    'SinkType' => 'KinesisVideoStreamPool',
                ],
                // ...
            ],
            'Sources' => [
                [
                    'SourceArn' => '<string>',
                    'SourceType' => 'ChimeSdkMeeting',
                ],
                // ...
            ],
            'Status' => 'Initializing|InProgress|Failed|Stopping|Stopped|Paused|NotStarted',
            'UpdatedTimestamp' => <DateTime>,
        ],
    ],
]

Result Details

Members
MediaPipeline
Type: MediaPipeline structure

The media pipeline object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetMediaPipelineKinesisVideoStreamPool

$result = $client->getMediaPipelineKinesisVideoStreamPool([/* ... */]);
$promise = $client->getMediaPipelineKinesisVideoStreamPoolAsync([/* ... */]);

Gets an Kinesis video stream pool.

Parameter Syntax

$result = $client->getMediaPipelineKinesisVideoStreamPool([
    'Identifier' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

Result Syntax

[
    'KinesisVideoStreamPoolConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'PoolArn' => '<string>',
        'PoolId' => '<string>',
        'PoolName' => '<string>',
        'PoolSize' => <integer>,
        'PoolStatus' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
        'StreamConfiguration' => [
            'DataRetentionInHours' => <integer>,
            'Region' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
KinesisVideoStreamPoolConfiguration

The video stream pool configuration object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetSpeakerSearchTask

$result = $client->getSpeakerSearchTask([/* ... */]);
$promise = $client->getSpeakerSearchTaskAsync([/* ... */]);

Retrieves the details of the specified speaker search task.

Parameter Syntax

$result = $client->getSpeakerSearchTask([
    'Identifier' => '<string>', // REQUIRED
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

SpeakerSearchTaskId
Required: Yes
Type: string

The ID of the speaker search task.

Result Syntax

[
    'SpeakerSearchTask' => [
        'CreatedTimestamp' => <DateTime>,
        'SpeakerSearchTaskId' => '<string>',
        'SpeakerSearchTaskStatus' => 'NotStarted|Initializing|InProgress|Failed|Stopping|Stopped',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SpeakerSearchTask
Type: SpeakerSearchTask structure

The details of the speaker search task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

GetVoiceToneAnalysisTask

$result = $client->getVoiceToneAnalysisTask([/* ... */]);
$promise = $client->getVoiceToneAnalysisTaskAsync([/* ... */]);

Retrieves the details of a voice tone analysis task.

Parameter Syntax

$result = $client->getVoiceToneAnalysisTask([
    'Identifier' => '<string>', // REQUIRED
    'VoiceToneAnalysisTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

VoiceToneAnalysisTaskId
Required: Yes
Type: string

The ID of the voice tone analysis task.

Result Syntax

[
    'VoiceToneAnalysisTask' => [
        'CreatedTimestamp' => <DateTime>,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceToneAnalysisTaskId' => '<string>',
        'VoiceToneAnalysisTaskStatus' => 'NotStarted|Initializing|InProgress|Failed|Stopping|Stopped',
    ],
]

Result Details

Members
VoiceToneAnalysisTask
Type: VoiceToneAnalysisTask structure

The details of the voice tone analysis task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListMediaCapturePipelines

$result = $client->listMediaCapturePipelines([/* ... */]);
$promise = $client->listMediaCapturePipelinesAsync([/* ... */]);

Returns a list of media pipelines.

Parameter Syntax

$result = $client->listMediaCapturePipelines([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call. Valid Range: 1 - 99.

NextToken
Type: string

The token used to retrieve the next page of results.

Result Syntax

[
    'MediaCapturePipelines' => [
        [
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MediaCapturePipelines
Type: Array of MediaCapturePipelineSummary structures

The media pipeline objects in the list.

NextToken
Type: string

The token used to retrieve the next page of results.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListMediaInsightsPipelineConfigurations

$result = $client->listMediaInsightsPipelineConfigurations([/* ... */]);
$promise = $client->listMediaInsightsPipelineConfigurationsAsync([/* ... */]);

Lists the available media insights pipeline configurations.

Parameter Syntax

$result = $client->listMediaInsightsPipelineConfigurations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'MediaInsightsPipelineConfigurations' => [
        [
            'MediaInsightsPipelineConfigurationArn' => '<string>',
            'MediaInsightsPipelineConfigurationId' => '<string>',
            'MediaInsightsPipelineConfigurationName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MediaInsightsPipelineConfigurations
Type: Array of MediaInsightsPipelineConfigurationSummary structures

The requested list of media insights pipeline configurations.

NextToken
Type: string

The token used to return the next page of results.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListMediaPipelineKinesisVideoStreamPools

$result = $client->listMediaPipelineKinesisVideoStreamPools([/* ... */]);
$promise = $client->listMediaPipelineKinesisVideoStreamPoolsAsync([/* ... */]);

Lists the video stream pools in the media pipeline.

Parameter Syntax

$result = $client->listMediaPipelineKinesisVideoStreamPools([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call.

NextToken
Type: string

The token used to return the next page of results.

Result Syntax

[
    'KinesisVideoStreamPools' => [
        [
            'PoolArn' => '<string>',
            'PoolId' => '<string>',
            'PoolName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
KinesisVideoStreamPools
Type: Array of KinesisVideoStreamPoolSummary structures

The list of video stream pools.

NextToken
Type: string

The token used to return the next page of results.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListMediaPipelines

$result = $client->listMediaPipelines([/* ... */]);
$promise = $client->listMediaPipelinesAsync([/* ... */]);

Returns a list of media pipelines.

Parameter Syntax

$result = $client->listMediaPipelines([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members
MaxResults
Type: int

The maximum number of results to return in a single call. Valid Range: 1 - 99.

NextToken
Type: string

The token used to retrieve the next page of results.

Result Syntax

[
    'MediaPipelines' => [
        [
            'MediaPipelineArn' => '<string>',
            'MediaPipelineId' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members
MediaPipelines
Type: Array of MediaPipelineSummary structures

The media pipeline objects in the list.

NextToken
Type: string

The token used to retrieve the next page of results.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ResourceLimitExceededException:

The request exceeds the resource limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Lists the tags available for a media pipeline.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceARN' => '<string>', // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's region, resource ID, and pipeline ID.

Result Syntax

[
    'Tags' => [
        [
            'Key' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
Tags
Type: Array of Tag structures

The tags associated with the specified media pipeline.

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StartSpeakerSearchTask

$result = $client->startSpeakerSearchTask([/* ... */]);
$promise = $client->startSpeakerSearchTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startSpeakerSearchTask([
    'ClientRequestToken' => '<string>',
    'Identifier' => '<string>', // REQUIRED
    'KinesisVideoStreamSourceTaskConfiguration' => [
        'ChannelId' => <integer>, // REQUIRED
        'FragmentNumber' => '<string>',
        'StreamArn' => '<string>', // REQUIRED
    ],
    'VoiceProfileDomainArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the client request. Use a different token for different speaker search tasks.

Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

KinesisVideoStreamSourceTaskConfiguration

The task configuration for the Kinesis video stream source of the media insights pipeline.

VoiceProfileDomainArn
Required: Yes
Type: string

The ARN of the voice profile domain that will store the voice profile.

Result Syntax

[
    'SpeakerSearchTask' => [
        'CreatedTimestamp' => <DateTime>,
        'SpeakerSearchTaskId' => '<string>',
        'SpeakerSearchTaskStatus' => 'NotStarted|Initializing|InProgress|Failed|Stopping|Stopped',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
SpeakerSearchTask
Type: SpeakerSearchTask structure

The details of the speaker search task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StartVoiceToneAnalysisTask

$result = $client->startVoiceToneAnalysisTask([/* ... */]);
$promise = $client->startVoiceToneAnalysisTaskAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->startVoiceToneAnalysisTask([
    'ClientRequestToken' => '<string>',
    'Identifier' => '<string>', // REQUIRED
    'KinesisVideoStreamSourceTaskConfiguration' => [
        'ChannelId' => <integer>, // REQUIRED
        'FragmentNumber' => '<string>',
        'StreamArn' => '<string>', // REQUIRED
    ],
    'LanguageCode' => 'en-US', // REQUIRED
]);

Parameter Details

Members
ClientRequestToken
Type: string

The unique identifier for the client request. Use a different token for different voice tone analysis tasks.

Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

KinesisVideoStreamSourceTaskConfiguration

The task configuration for the Kinesis video stream source of the media insights pipeline.

LanguageCode
Required: Yes
Type: string

The language code.

Result Syntax

[
    'VoiceToneAnalysisTask' => [
        'CreatedTimestamp' => <DateTime>,
        'UpdatedTimestamp' => <DateTime>,
        'VoiceToneAnalysisTaskId' => '<string>',
        'VoiceToneAnalysisTaskStatus' => 'NotStarted|Initializing|InProgress|Failed|Stopping|Stopped',
    ],
]

Result Details

Members
VoiceToneAnalysisTask
Type: VoiceToneAnalysisTask structure

The details of the voice tone analysis task.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StopSpeakerSearchTask

$result = $client->stopSpeakerSearchTask([/* ... */]);
$promise = $client->stopSpeakerSearchTaskAsync([/* ... */]);

Stops a speaker search task.

Parameter Syntax

$result = $client->stopSpeakerSearchTask([
    'Identifier' => '<string>', // REQUIRED
    'SpeakerSearchTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

SpeakerSearchTaskId
Required: Yes
Type: string

The speaker search task ID.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

StopVoiceToneAnalysisTask

$result = $client->stopVoiceToneAnalysisTask([/* ... */]);
$promise = $client->stopVoiceToneAnalysisTaskAsync([/* ... */]);

Stops a voice tone analysis task.

Parameter Syntax

$result = $client->stopVoiceToneAnalysisTask([
    'Identifier' => '<string>', // REQUIRED
    'VoiceToneAnalysisTaskId' => '<string>', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

VoiceToneAnalysisTaskId
Required: Yes
Type: string

The ID of the voice tone analysis task.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

The ARN of the media pipeline that you want to tag. Consists of the pipeline's endpoint region, resource ID, and pipeline ID.

Parameter Syntax

$result = $client->tagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'Value' => '<string>', // REQUIRED
        ],
        // ...
    ],
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the media pipeline associated with any tags. The ARN consists of the pipeline's endpoint region, resource ID, and pipeline ID.

Tags
Required: Yes
Type: Array of Tag structures

The tags associated with the specified media pipeline.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes any tags from a media pipeline.

Parameter Syntax

$result = $client->untagResource([
    'ResourceARN' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
ResourceARN
Required: Yes
Type: string

The ARN of the pipeline that you want to untag.

TagKeys
Required: Yes
Type: Array of strings

The key/value pairs in the tag that you want to remove.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

NotFoundException:

One or more of the resources in the request does not exist in the system.

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateMediaInsightsPipelineConfiguration

$result = $client->updateMediaInsightsPipelineConfiguration([/* ... */]);
$promise = $client->updateMediaInsightsPipelineConfigurationAsync([/* ... */]);

Updates the media insights pipeline's configuration settings.

Parameter Syntax

$result = $client->updateMediaInsightsPipelineConfiguration([
    'Elements' => [ // REQUIRED
        [
            'AmazonTranscribeCallAnalyticsProcessorConfiguration' => [
                'CallAnalyticsStreamCategories' => ['<string>', ...],
                'ContentIdentificationType' => 'PII',
                'ContentRedactionType' => 'PII',
                'EnablePartialResultsStabilization' => true || false,
                'FilterPartialResults' => true || false,
                'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR', // REQUIRED
                'LanguageModelName' => '<string>',
                'PartialResultsStability' => 'high|medium|low',
                'PiiEntityTypes' => '<string>',
                'PostCallAnalyticsSettings' => [
                    'ContentRedactionOutput' => 'redacted|redacted_and_unredacted',
                    'DataAccessRoleArn' => '<string>', // REQUIRED
                    'OutputEncryptionKMSKeyId' => '<string>',
                    'OutputLocation' => '<string>', // REQUIRED
                ],
                'VocabularyFilterMethod' => 'remove|mask|tag',
                'VocabularyFilterName' => '<string>',
                'VocabularyName' => '<string>',
            ],
            'AmazonTranscribeProcessorConfiguration' => [
                'ContentIdentificationType' => 'PII',
                'ContentRedactionType' => 'PII',
                'EnablePartialResultsStabilization' => true || false,
                'FilterPartialResults' => true || false,
                'IdentifyLanguage' => true || false,
                'IdentifyMultipleLanguages' => true || false,
                'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                'LanguageModelName' => '<string>',
                'LanguageOptions' => '<string>',
                'PartialResultsStability' => 'high|medium|low',
                'PiiEntityTypes' => '<string>',
                'PreferredLanguage' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                'ShowSpeakerLabel' => true || false,
                'VocabularyFilterMethod' => 'remove|mask|tag',
                'VocabularyFilterName' => '<string>',
                'VocabularyFilterNames' => '<string>',
                'VocabularyName' => '<string>',
                'VocabularyNames' => '<string>',
            ],
            'KinesisDataStreamSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'LambdaFunctionSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'S3RecordingSinkConfiguration' => [
                'Destination' => '<string>',
                'RecordingFileFormat' => 'Wav|Opus',
            ],
            'SnsTopicSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'SqsQueueSinkConfiguration' => [
                'InsightsTarget' => '<string>',
            ],
            'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink', // REQUIRED
            'VoiceAnalyticsProcessorConfiguration' => [
                'SpeakerSearchStatus' => 'Enabled|Disabled',
                'VoiceToneAnalysisStatus' => 'Enabled|Disabled',
            ],
            'VoiceEnhancementSinkConfiguration' => [
                'Disabled' => true || false,
            ],
        ],
        // ...
    ],
    'Identifier' => '<string>', // REQUIRED
    'RealTimeAlertConfiguration' => [
        'Disabled' => true || false,
        'Rules' => [
            [
                'IssueDetectionConfiguration' => [
                    'RuleName' => '<string>', // REQUIRED
                ],
                'KeywordMatchConfiguration' => [
                    'Keywords' => ['<string>', ...], // REQUIRED
                    'Negate' => true || false,
                    'RuleName' => '<string>', // REQUIRED
                ],
                'SentimentConfiguration' => [
                    'RuleName' => '<string>', // REQUIRED
                    'SentimentType' => 'NEGATIVE', // REQUIRED
                    'TimePeriod' => <integer>, // REQUIRED
                ],
                'Type' => 'KeywordMatch|Sentiment|IssueDetection', // REQUIRED
            ],
            // ...
        ],
    ],
    'ResourceAccessRoleArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
Elements
Required: Yes
Type: Array of MediaInsightsPipelineConfigurationElement structures

The elements in the request, such as a processor for Amazon Transcribe or a sink for a Kinesis Data Stream..

Identifier
Required: Yes
Type: string

The unique identifier for the resource to be updated. Valid values include the name and ARN of the media insights pipeline configuration.

RealTimeAlertConfiguration
Type: RealTimeAlertConfiguration structure

The configuration settings for real-time alerts for the media insights pipeline.

ResourceAccessRoleArn
Required: Yes
Type: string

The ARN of the role used by the service to access Amazon Web Services resources.

Result Syntax

[
    'MediaInsightsPipelineConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'Elements' => [
            [
                'AmazonTranscribeCallAnalyticsProcessorConfiguration' => [
                    'CallAnalyticsStreamCategories' => ['<string>', ...],
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PostCallAnalyticsSettings' => [
                        'ContentRedactionOutput' => 'redacted|redacted_and_unredacted',
                        'DataAccessRoleArn' => '<string>',
                        'OutputEncryptionKMSKeyId' => '<string>',
                        'OutputLocation' => '<string>',
                    ],
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyName' => '<string>',
                ],
                'AmazonTranscribeProcessorConfiguration' => [
                    'ContentIdentificationType' => 'PII',
                    'ContentRedactionType' => 'PII',
                    'EnablePartialResultsStabilization' => true || false,
                    'FilterPartialResults' => true || false,
                    'IdentifyLanguage' => true || false,
                    'IdentifyMultipleLanguages' => true || false,
                    'LanguageCode' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'LanguageModelName' => '<string>',
                    'LanguageOptions' => '<string>',
                    'PartialResultsStability' => 'high|medium|low',
                    'PiiEntityTypes' => '<string>',
                    'PreferredLanguage' => 'en-US|en-GB|es-US|fr-CA|fr-FR|en-AU|it-IT|de-DE|pt-BR',
                    'ShowSpeakerLabel' => true || false,
                    'VocabularyFilterMethod' => 'remove|mask|tag',
                    'VocabularyFilterName' => '<string>',
                    'VocabularyFilterNames' => '<string>',
                    'VocabularyName' => '<string>',
                    'VocabularyNames' => '<string>',
                ],
                'KinesisDataStreamSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'LambdaFunctionSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'S3RecordingSinkConfiguration' => [
                    'Destination' => '<string>',
                    'RecordingFileFormat' => 'Wav|Opus',
                ],
                'SnsTopicSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'SqsQueueSinkConfiguration' => [
                    'InsightsTarget' => '<string>',
                ],
                'Type' => 'AmazonTranscribeCallAnalyticsProcessor|VoiceAnalyticsProcessor|AmazonTranscribeProcessor|KinesisDataStreamSink|LambdaFunctionSink|SqsQueueSink|SnsTopicSink|S3RecordingSink|VoiceEnhancementSink',
                'VoiceAnalyticsProcessorConfiguration' => [
                    'SpeakerSearchStatus' => 'Enabled|Disabled',
                    'VoiceToneAnalysisStatus' => 'Enabled|Disabled',
                ],
                'VoiceEnhancementSinkConfiguration' => [
                    'Disabled' => true || false,
                ],
            ],
            // ...
        ],
        'MediaInsightsPipelineConfigurationArn' => '<string>',
        'MediaInsightsPipelineConfigurationId' => '<string>',
        'MediaInsightsPipelineConfigurationName' => '<string>',
        'RealTimeAlertConfiguration' => [
            'Disabled' => true || false,
            'Rules' => [
                [
                    'IssueDetectionConfiguration' => [
                        'RuleName' => '<string>',
                    ],
                    'KeywordMatchConfiguration' => [
                        'Keywords' => ['<string>', ...],
                        'Negate' => true || false,
                        'RuleName' => '<string>',
                    ],
                    'SentimentConfiguration' => [
                        'RuleName' => '<string>',
                        'SentimentType' => 'NEGATIVE',
                        'TimePeriod' => <integer>,
                    ],
                    'Type' => 'KeywordMatch|Sentiment|IssueDetection',
                ],
                // ...
            ],
        ],
        'ResourceAccessRoleArn' => '<string>',
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
MediaInsightsPipelineConfiguration

The updated configuration settings.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateMediaInsightsPipelineStatus

$result = $client->updateMediaInsightsPipelineStatus([/* ... */]);
$promise = $client->updateMediaInsightsPipelineStatusAsync([/* ... */]);

Updates the status of a media insights pipeline.

Parameter Syntax

$result = $client->updateMediaInsightsPipelineStatus([
    'Identifier' => '<string>', // REQUIRED
    'UpdateStatus' => 'Pause|Resume', // REQUIRED
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the resource to be updated. Valid values include the ID and ARN of the media insights pipeline.

UpdateStatus
Required: Yes
Type: string

The requested status of the media insights pipeline.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

NotFoundException:

One or more of the resources in the request does not exist in the system.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

UpdateMediaPipelineKinesisVideoStreamPool

$result = $client->updateMediaPipelineKinesisVideoStreamPool([/* ... */]);
$promise = $client->updateMediaPipelineKinesisVideoStreamPoolAsync([/* ... */]);

Updates an Amazon Kinesis Video Stream pool in a media pipeline.

Parameter Syntax

$result = $client->updateMediaPipelineKinesisVideoStreamPool([
    'Identifier' => '<string>', // REQUIRED
    'StreamConfiguration' => [
        'DataRetentionInHours' => <integer>,
    ],
]);

Parameter Details

Members
Identifier
Required: Yes
Type: string

The unique identifier of the requested resource. Valid values include the name and ARN of the media pipeline Kinesis Video Stream pool.

StreamConfiguration

The configuration settings for the video stream.

Result Syntax

[
    'KinesisVideoStreamPoolConfiguration' => [
        'CreatedTimestamp' => <DateTime>,
        'PoolArn' => '<string>',
        'PoolId' => '<string>',
        'PoolName' => '<string>',
        'PoolSize' => <integer>,
        'PoolStatus' => 'CREATING|ACTIVE|UPDATING|DELETING|FAILED',
        'StreamConfiguration' => [
            'DataRetentionInHours' => <integer>,
            'Region' => '<string>',
        ],
        'UpdatedTimestamp' => <DateTime>,
    ],
]

Result Details

Members
KinesisVideoStreamPoolConfiguration

The video stream pool configuration object.

Errors

BadRequestException:

The input parameters don't match the service's restrictions.

ForbiddenException:

The client is permanently forbidden from making the request.

NotFoundException:

One or more of the resources in the request does not exist in the system.

UnauthorizedClientException:

The client is not currently authorized to make the request.

ThrottledClientException:

The client exceeded its request rate limit.

ConflictException:

The request could not be processed because of conflict in the current state of the resource.

ServiceUnavailableException:

The service is currently unavailable.

ServiceFailureException:

The service encountered an unexpected error.

Shapes

ActiveSpeakerOnlyConfiguration

Description

Defines the configuration for an ActiveSpeakerOnly video tile.

Members
ActiveSpeakerPosition
Type: string

The position of the ActiveSpeakerOnly video tile.

AmazonTranscribeCallAnalyticsProcessorConfiguration

Description

A structure that contains the configuration settings for an Amazon Transcribe call analytics processor.

Members
CallAnalyticsStreamCategories
Type: Array of strings

By default, all CategoryEvents are sent to the insights target. If this parameter is specified, only included categories are sent to the insights target.

ContentIdentificationType
Type: string

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

ContentRedactionType
Type: string

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you do, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

EnablePartialResultsStabilization
Type: boolean

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy. For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

FilterPartialResults
Type: boolean

If true, UtteranceEvents with IsPartial: true are filtered out of the insights target.

LanguageCode
Required: Yes
Type: string

The language code in the configuration.

LanguageModelName
Type: string

Specifies the name of the custom language model to use when processing a transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code specified in the transcription request. If the languages don't match, the custom language model isn't applied. Language mismatches don't generate errors or warnings.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

PartialResultsStability
Type: string

Specifies the level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

PiiEntityTypes
Type: string

Specifies the types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

Length Constraints: Minimum length of 1. Maximum length of 300.

PostCallAnalyticsSettings
Type: PostCallAnalyticsSettings structure

The settings for a post-call analysis task in an analytics configuration.

VocabularyFilterMethod
Type: string

Specifies how to apply a vocabulary filter to a transcript.

To replace words with ***, choose mask.

To delete words, choose remove.

To flag words without changing them, choose tag.

VocabularyFilterName
Type: string

Specifies the name of the custom vocabulary filter to use when processing a transcription. Note that vocabulary filter names are case sensitive.

If the language of the specified custom vocabulary filter doesn't match the language identified in your media, the vocabulary filter is not applied to your transcription.

For more information, see Using vocabulary filtering with unwanted words in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

VocabularyName
Type: string

Specifies the name of the custom vocabulary to use when processing a transcription. Note that vocabulary names are case sensitive.

If the language of the specified custom vocabulary doesn't match the language identified in your media, the custom vocabulary is not applied to your transcription.

For more information, see Custom vocabularies in the Amazon Transcribe Developer Guide.

Length Constraints: Minimum length of 1. Maximum length of 200.

AmazonTranscribeProcessorConfiguration

Description

A structure that contains the configuration settings for an Amazon Transcribe processor.

Calls to this API must include a LanguageCode, IdentifyLanguage, or IdentifyMultipleLanguages parameter. If you include more than one of those parameters, your transcription job fails.

Members
ContentIdentificationType
Type: string

Labels all personally identifiable information (PII) identified in your transcript.

Content identification is performed at the segment level; PII specified in PiiEntityTypes is flagged upon complete transcription of an audio segment.

You can’t set ContentIdentificationType and ContentRedactionType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

ContentRedactionType
Type: string

Redacts all personally identifiable information (PII) identified in your transcript.

Content redaction is performed at the segment level; PII specified in PiiEntityTypes is redacted upon complete transcription of an audio segment.

You can’t set ContentRedactionType and ContentIdentificationType in the same request. If you set both, your request returns a BadRequestException.

For more information, see Redacting or identifying personally identifiable information in the Amazon Transcribe Developer Guide.

EnablePartialResultsStabilization
Type: boolean

Enables partial result stabilization for your transcription. Partial result stabilization can reduce latency in your output, but may impact accuracy.

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

FilterPartialResults
Type: boolean

If true, TranscriptEvents with IsPartial: true are filtered out of the insights target.

IdentifyLanguage
Type: boolean

Turns language identification on or off.

IdentifyMultipleLanguages
Type: boolean

Turns language identification on or off for multiple languages.

LanguageCode
Type: string

The language code that represents the language spoken in your audio.

If you're unsure of the language spoken in your audio, consider using IdentifyLanguage to enable automatic language identification.

For a list of languages that real-time Call Analytics supports, see the Supported languages table in the Amazon Transcribe Developer Guide.

LanguageModelName
Type: string

The name of the custom language model that you want to use when processing your transcription. Note that language model names are case sensitive.

The language of the specified language model must match the language code you specify in your transcription request. If the languages don't match, the custom language model isn't applied. There are no errors or warnings associated with a language mismatch.

For more information, see Custom language models in the Amazon Transcribe Developer Guide.

LanguageOptions
Type: string

The language options for the transcription, such as automatic language detection.

PartialResultsStability
Type: string

The level of stability to use when you enable partial results stabilization (EnablePartialResultsStabilization).

Low stability provides the highest accuracy. High stability transcribes faster, but with slightly lower accuracy.

For more information, see Partial-result stabilization in the Amazon Transcribe Developer Guide.

PiiEntityTypes
Type: string

The types of personally identifiable information (PII) to redact from a transcript. You can include as many types as you'd like, or you can select ALL.

To include PiiEntityTypes in your Call Analytics request, you must also include ContentIdentificationType or ContentRedactionType, but you can't include both.

Values must be comma-separated and can include: ADDRESS, BANK_ACCOUNT_NUMBER, BANK_ROUTING, CREDIT_DEBIT_CVV, CREDIT_DEBIT_EXPIRY, CREDIT_DEBIT_NUMBER, EMAIL, NAME, PHONE, PIN, SSN, or ALL.

If you leave this parameter empty, the default behavior is equivalent to ALL.

PreferredLanguage
Type: string

The preferred language for the transcription.

ShowSpeakerLabel
Type: boolean

Enables speaker partitioning (diarization) in your transcription output. Speaker partitioning labels the speech from individual speakers in your media file.

For more information, see Partitioning speakers (diarization) in the Amazon Transcribe Developer Guide.

VocabularyFilterMethod
Type: string

The vocabulary filtering method used in your Call Analytics transcription.

VocabularyFilterName
Type: string

The name of the custom vocabulary filter that you specified in your Call Analytics request.

Length Constraints: Minimum length of 1. Maximum length of 200.

VocabularyFilterNames
Type: string

The names of the custom vocabulary filter or filters using during transcription.

VocabularyName
Type: string

The name of the custom vocabulary that you specified in your Call Analytics request.

Length Constraints: Minimum length of 1. Maximum length of 200.

VocabularyNames
Type: string

The names of the custom vocabulary or vocabularies used during transcription.

ArtifactsConcatenationConfiguration

Description

The configuration for the artifacts concatenation.

Members
Audio
Required: Yes
Type: AudioConcatenationConfiguration structure

The configuration for the audio artifacts concatenation.

CompositedVideo
Required: Yes
Type: CompositedVideoConcatenationConfiguration structure

The configuration for the composited video artifacts concatenation.

Content
Required: Yes
Type: ContentConcatenationConfiguration structure

The configuration for the content artifacts concatenation.

DataChannel
Required: Yes
Type: DataChannelConcatenationConfiguration structure

The configuration for the data channel artifacts concatenation.

MeetingEvents
Required: Yes
Type: MeetingEventsConcatenationConfiguration structure

The configuration for the meeting events artifacts concatenation.

TranscriptionMessages
Required: Yes
Type: TranscriptionMessagesConcatenationConfiguration structure

The configuration for the transcription messages artifacts concatenation.

Video
Required: Yes
Type: VideoConcatenationConfiguration structure

The configuration for the video artifacts concatenation.

ArtifactsConfiguration

Description

The configuration for the artifacts.

Members
Audio
Required: Yes
Type: AudioArtifactsConfiguration structure

The configuration for the audio artifacts.

CompositedVideo

Enables video compositing.

Content
Required: Yes
Type: ContentArtifactsConfiguration structure

The configuration for the content artifacts.

Video
Required: Yes
Type: VideoArtifactsConfiguration structure

The configuration for the video artifacts.

AudioArtifactsConfiguration

Description

The audio artifact configuration object.

Members
MuxType
Required: Yes
Type: string

The MUX type of the audio artifact configuration object.

AudioConcatenationConfiguration

Description

The audio artifact concatenation configuration object.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

BadRequestException

Description

The input parameters don't match the service's restrictions.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

ChannelDefinition

Description

Defines an audio channel in a Kinesis video stream.

Members
ChannelId
Required: Yes
Type: int

The channel ID.

ParticipantRole
Type: string

Specifies whether the audio in a channel belongs to the AGENT or CUSTOMER.

ChimeSdkMeetingConcatenationConfiguration

Description

The configuration object of the Amazon Chime SDK meeting concatenation for a specified media pipeline.

Members
ArtifactsConfiguration
Required: Yes
Type: ArtifactsConcatenationConfiguration structure

The configuration for the artifacts in an Amazon Chime SDK meeting concatenation.

ChimeSdkMeetingConfiguration

Description

The configuration object of the Amazon Chime SDK meeting for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Members
ArtifactsConfiguration
Type: ArtifactsConfiguration structure

The configuration for the artifacts in an Amazon Chime SDK meeting.

SourceConfiguration
Type: SourceConfiguration structure

The source configuration for a specified media pipeline.

ChimeSdkMeetingLiveConnectorConfiguration

Description

The media pipeline's configuration object.

Members
Arn
Required: Yes
Type: string

The configuration object's Chime SDK meeting ARN.

CompositedVideo

The media pipeline's composited video.

MuxType
Required: Yes
Type: string

The configuration object's multiplex type.

SourceConfiguration
Type: SourceConfiguration structure

The source configuration settings of the media pipeline's configuration object.

CompositedVideoArtifactsConfiguration

Description

Specifies the configuration for compositing video artifacts.

Members
GridViewConfiguration
Required: Yes
Type: GridViewConfiguration structure

The GridView configuration setting.

Layout
Type: string

The layout setting, such as GridView in the configuration object.

Resolution
Type: string

The video resolution setting in the configuration object. Default: HD at 1280 x 720. FHD resolution: 1920 x 1080.

CompositedVideoConcatenationConfiguration

Description

The composited video configuration object for a specified media pipeline. SourceType must be ChimeSdkMeeting.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

ConcatenationSink

Description

The data sink of the configuration object.

Members
S3BucketSinkConfiguration
Required: Yes
Type: S3BucketSinkConfiguration structure

The configuration settings for an Amazon S3 bucket sink.

Type
Required: Yes
Type: string

The type of data sink in the configuration object.

ConcatenationSource

Description

The source type and media pipeline configuration settings in a configuration object.

Members
MediaCapturePipelineSourceConfiguration
Required: Yes
Type: MediaCapturePipelineSourceConfiguration structure

The concatenation settings for the media pipeline in a configuration object.

Type
Required: Yes
Type: string

The type of concatenation source in a configuration object.

ConflictException

Description

The request could not be processed because of conflict in the current state of the resource.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

ContentArtifactsConfiguration

Description

The content artifact object.

Members
MuxType
Type: string

The MUX type of the artifact configuration.

State
Required: Yes
Type: string

Indicates whether the content artifact is enabled or disabled.

ContentConcatenationConfiguration

Description

The composited content configuration object for a specified media pipeline.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

DataChannelConcatenationConfiguration

Description

The content configuration object's data channel.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

ForbiddenException

Description

The client is permanently forbidden from making the request.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request id associated with the call responsible for the exception.

FragmentSelector

Description

Describes the timestamp range and timestamp origin of a range of fragments.

Only fragments with a start timestamp greater than or equal to the given start time and less than or equal to the end time are returned. For example, say a stream contains fragments with the following start timestamps:

  • 00:00:00

  • 00:00:02

  • 00:00:04

  • 00:00:06

A fragment selector range with a start time of 00:00:01 and end time of 00:00:04 would return the fragments with start times of 00:00:02 and 00:00:04.

Members
FragmentSelectorType
Required: Yes
Type: string

The origin of the timestamps to use, Server or Producer. For more information, see StartSelectorType in the Amazon Kinesis Video Streams Developer Guide.

TimestampRange
Required: Yes
Type: TimestampRange structure

The range of timestamps to return.

GridViewConfiguration

Description

Specifies the type of grid layout.

Members
ActiveSpeakerOnlyConfiguration

The configuration settings for an ActiveSpeakerOnly video tile.

CanvasOrientation
Type: string

The orientation setting, horizontal or vertical.

ContentShareLayout
Required: Yes
Type: string

Defines the layout of the video tiles when content sharing is enabled.

HorizontalLayoutConfiguration

The configuration settings for a horizontal layout.

PresenterOnlyConfiguration
Type: PresenterOnlyConfiguration structure

Defines the configuration options for a presenter only video tile.

VerticalLayoutConfiguration
Type: VerticalLayoutConfiguration structure

The configuration settings for a vertical layout.

VideoAttribute
Type: VideoAttribute structure

The attribute settings for the video tiles.

HorizontalLayoutConfiguration

Description

Defines the configuration settings for the horizontal layout.

Members
TileAspectRatio
Type: string

Specifies the aspect ratio of all video tiles.

TileCount
Type: int

The maximum number of video tiles to display.

TileOrder
Type: string

Sets the automatic ordering of the video tiles.

TilePosition
Type: string

Sets the position of horizontal tiles.

IssueDetectionConfiguration

Description

A structure that contains the configuration settings for an issue detection task.

Members
RuleName
Required: Yes
Type: string

The name of the issue detection rule.

KeywordMatchConfiguration

Description

A structure that contains the settings for a keyword match task.

Members
Keywords
Required: Yes
Type: Array of strings

The keywords or phrases that you want to match.

Negate
Type: boolean

Matches keywords or phrases on their presence or absence. If set to TRUE, the rule matches when all the specified keywords or phrases are absent. Default: FALSE.

RuleName
Required: Yes
Type: string

The name of the keyword match rule.

KinesisDataStreamSinkConfiguration

Description

A structure that contains the configuration settings for a Kinesis Data Stream sink.

Members
InsightsTarget
Type: string

The ARN of the sink.

KinesisVideoStreamConfiguration

Description

The configuration of an Kinesis video stream.

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 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.

Members
DataRetentionInHours
Type: int

The amount of time that data is retained.

Region
Required: Yes
Type: string

The Amazon Web Services Region of the video stream.

KinesisVideoStreamConfigurationUpdate

Description

The updated Kinesis video stream configuration object.

Members
DataRetentionInHours
Type: int

The updated time that data is retained.

KinesisVideoStreamPoolConfiguration

Description

The video stream pool configuration object.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the configuration was created.

PoolArn
Type: string

The ARN of the video stream pool configuration.

PoolId
Type: string

The ID of the video stream pool in the configuration.

PoolName
Type: string

The name of the video stream pool configuration.

PoolSize
Type: int

The size of the video stream pool in the configuration.

PoolStatus
Type: string

The status of the video stream pool in the configuration.

StreamConfiguration

The Kinesis video stream pool configuration object.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the configuration was updated.

KinesisVideoStreamPoolSummary

Description

A summary of the Kinesis video stream pool.

Members
PoolArn
Type: string

The ARN of the video stream pool.

PoolId
Type: string

The ID of the video stream pool.

PoolName
Type: string

The name of the video stream pool.

KinesisVideoStreamRecordingSourceRuntimeConfiguration

Description

A structure that contains the runtime settings for recording a Kinesis video stream.

Members
FragmentSelector
Required: Yes
Type: FragmentSelector structure

Describes the timestamp range and timestamp origin of a range of fragments in the Kinesis video stream.

Streams
Required: Yes
Type: Array of RecordingStreamConfiguration structures

The stream or streams to be recorded.

KinesisVideoStreamSourceRuntimeConfiguration

Description

The runtime configuration settings for the Kinesis video stream source.

Members
MediaEncoding
Required: Yes
Type: string

Specifies the encoding of your input audio. Supported format: PCM (only signed 16-bit little-endian audio formats, which does not include WAV)

For more information, see Media formats in the Amazon Transcribe Developer Guide.

MediaSampleRate
Required: Yes
Type: int

The sample rate of the input audio (in hertz). Low-quality audio, such as telephone audio, is typically around 8,000 Hz. High-quality audio typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must match that of your audio.

Valid Range: Minimum value of 8000. Maximum value of 48000.

Streams
Required: Yes
Type: Array of StreamConfiguration structures

The streams in the source runtime configuration of a Kinesis video stream.

KinesisVideoStreamSourceTaskConfiguration

Description

The task configuration settings for the Kinesis video stream source.

Members
ChannelId
Required: Yes
Type: int

The channel ID.

FragmentNumber
Type: string

The unique identifier of the fragment to begin processing.

StreamArn
Required: Yes
Type: string

The ARN of the stream.

LambdaFunctionSinkConfiguration

Description

A structure that contains the configuration settings for an AWS Lambda function's data sink.

Members
InsightsTarget
Type: string

The ARN of the sink.

LiveConnectorRTMPConfiguration

Description

The media pipeline's RTMP configuration object.

Members
AudioChannels
Type: string

The audio channels set for the RTMP configuration

AudioSampleRate
Type: string

The audio sample rate set for the RTMP configuration. Default: 48000.

Url
Required: Yes
Type: string

The URL of the RTMP configuration.

LiveConnectorSinkConfiguration

Description

The media pipeline's sink configuration settings.

Members
RTMPConfiguration
Required: Yes
Type: LiveConnectorRTMPConfiguration structure

The sink configuration's RTMP configuration settings.

SinkType
Required: Yes
Type: string

The sink configuration's sink type.

LiveConnectorSourceConfiguration

Description

The data source configuration object of a streaming media pipeline.

Members
ChimeSdkMeetingLiveConnectorConfiguration
Required: Yes
Type: ChimeSdkMeetingLiveConnectorConfiguration structure

The configuration settings of the connector pipeline.

SourceType
Required: Yes
Type: string

The source configuration's media source type.

MediaCapturePipeline

Description

A media pipeline object consisting of an ID, source type, source ARN, a sink type, a sink ARN, and a configuration object.

Members
ChimeSdkMeetingConfiguration

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

CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the pipeline was created, in ISO 8601 format.

MediaPipelineArn
Type: string

The ARN of the media capture pipeline

MediaPipelineId
Type: string

The ID of a media pipeline.

SinkArn
Type: string

ARN of the destination to which the media artifacts are saved.

SinkType
Type: string

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

SourceArn
Type: string

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

SourceType
Type: string

Source type from which media artifacts are saved. You must use ChimeMeeting.

Status
Type: string

The status of the media pipeline.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the pipeline was updated, in ISO 8601 format.

MediaCapturePipelineSourceConfiguration

Description

The source configuration object of a media capture pipeline.

Members
ChimeSdkMeetingConfiguration
Required: Yes
Type: ChimeSdkMeetingConcatenationConfiguration structure

The meeting configuration settings in a media capture pipeline configuration object.

MediaPipelineArn
Required: Yes
Type: string

The media pipeline ARN in the configuration object of a media capture pipeline.

MediaCapturePipelineSummary

Description

The summary data of a media capture pipeline.

Members
MediaPipelineArn
Type: string

The ARN of the media pipeline in the summary.

MediaPipelineId
Type: string

The ID of the media pipeline in the summary.

MediaConcatenationPipeline

Description

Concatenates audio and video data from one or more data streams.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the concatenation pipeline was created.

MediaPipelineArn
Type: string

The ARN of the media pipeline that you specify in the SourceConfiguration object.

MediaPipelineId
Type: string

The ID of the media pipeline being concatenated.

Sinks
Type: Array of ConcatenationSink structures

The data sinks of the concatenation pipeline.

Sources
Type: Array of ConcatenationSource structures

The data sources being concatenated.

Status
Type: string

The status of the concatenation pipeline.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the concatenation pipeline was last updated.

MediaInsightsPipeline

Description

A media pipeline that streams call analytics data.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the media insights pipeline was created.

ElementStatuses
Type: Array of MediaInsightsPipelineElementStatus structures

The statuses that the elements in a media insights pipeline can have during data processing.

KinesisVideoStreamRecordingSourceRuntimeConfiguration

The runtime configuration settings for a Kinesis recording video stream in a media insights pipeline.

KinesisVideoStreamSourceRuntimeConfiguration

The configuration settings for a Kinesis runtime video stream in a media insights pipeline.

MediaInsightsPipelineConfigurationArn
Type: string

The ARN of a media insight pipeline's configuration settings.

MediaInsightsRuntimeMetadata
Type: Associative array of custom strings keys (NonEmptyString) to strings

The runtime metadata of a media insights pipeline.

MediaPipelineArn
Type: string

The ARN of a media insights pipeline.

MediaPipelineId
Type: string

The ID of a media insights pipeline.

S3RecordingSinkRuntimeConfiguration

The runtime configuration of the Amazon S3 bucket that stores recordings in a media insights pipeline.

Status
Type: string

The status of a media insights pipeline.

MediaInsightsPipelineConfiguration

Description

A structure that contains the configuration settings for a media insights pipeline.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the configuration was created.

Elements
Type: Array of MediaInsightsPipelineConfigurationElement structures

The elements in the configuration.

MediaInsightsPipelineConfigurationArn
Type: string

The ARN of the configuration.

MediaInsightsPipelineConfigurationId
Type: string

The ID of the configuration.

MediaInsightsPipelineConfigurationName
Type: string

The name of the configuration.

RealTimeAlertConfiguration
Type: RealTimeAlertConfiguration structure

Lists the rules that trigger a real-time alert.

ResourceAccessRoleArn
Type: string

The ARN of the role used by the service to access Amazon Web Services resources.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the configuration was last updated.

MediaInsightsPipelineConfigurationElement

Description

An element in a media insights pipeline configuration.

Members
AmazonTranscribeCallAnalyticsProcessorConfiguration

The analytics configuration settings for transcribing audio in a media insights pipeline configuration element.

AmazonTranscribeProcessorConfiguration

The transcription processor configuration settings in a media insights pipeline configuration element.

KinesisDataStreamSinkConfiguration

The configuration settings for the Kinesis Data Stream Sink in a media insights pipeline configuration element.

LambdaFunctionSinkConfiguration

The configuration settings for the Amazon Web Services Lambda sink in a media insights pipeline configuration element.

S3RecordingSinkConfiguration

The configuration settings for the Amazon S3 recording bucket in a media insights pipeline configuration element.

SnsTopicSinkConfiguration
Type: SnsTopicSinkConfiguration structure

The configuration settings for an SNS topic sink in a media insights pipeline configuration element.

SqsQueueSinkConfiguration
Type: SqsQueueSinkConfiguration structure

The configuration settings for an SQS queue sink in a media insights pipeline configuration element.

Type
Required: Yes
Type: string

The element type.

VoiceAnalyticsProcessorConfiguration

The voice analytics configuration settings in a media insights pipeline configuration element.

VoiceEnhancementSinkConfiguration

The configuration settings for voice enhancement sink in a media insights pipeline configuration element.

MediaInsightsPipelineConfigurationSummary

Description

A summary of the media insights pipeline configuration.

Members
MediaInsightsPipelineConfigurationArn
Type: string

The ARN of the media insights pipeline configuration.

MediaInsightsPipelineConfigurationId
Type: string

The ID of the media insights pipeline configuration.

MediaInsightsPipelineConfigurationName
Type: string

The name of the media insights pipeline configuration.

MediaInsightsPipelineElementStatus

Description

The status of the pipeline element.

Members
Status
Type: string

The element's status.

Type
Type: string

The type of status.

MediaLiveConnectorPipeline

Description

The connector pipeline.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the connector pipeline was created.

MediaPipelineArn
Type: string

The connector pipeline's ARN.

MediaPipelineId
Type: string

The connector pipeline's ID.

Sinks
Type: Array of LiveConnectorSinkConfiguration structures

The connector pipeline's data sinks.

Sources
Type: Array of LiveConnectorSourceConfiguration structures

The connector pipeline's data sources.

Status
Type: string

The connector pipeline's status.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the connector pipeline was last updated.

MediaPipeline

Description

A pipeline consisting of a media capture, media concatenation, or live-streaming pipeline.

Members
MediaCapturePipeline
Type: MediaCapturePipeline structure

A pipeline that enables users to capture audio and video.

MediaConcatenationPipeline
Type: MediaConcatenationPipeline structure

The media concatenation pipeline in a media pipeline.

MediaInsightsPipeline
Type: MediaInsightsPipeline structure

The media insights pipeline of a media pipeline.

MediaLiveConnectorPipeline
Type: MediaLiveConnectorPipeline structure

The connector pipeline of the media pipeline.

MediaStreamPipeline
Type: MediaStreamPipeline structure

Designates a media pipeline as a media stream pipeline.

MediaPipelineSummary

Description

The summary of the media pipeline.

Members
MediaPipelineArn
Type: string

The ARN of the media pipeline in the summary.

MediaPipelineId
Type: string

The ID of the media pipeline in the summary.

MediaStreamPipeline

Description

Structure that contains the settings for a media stream pipeline.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the media stream pipeline was created.

MediaPipelineArn
Type: string

The ARN of the media stream pipeline.

MediaPipelineId
Type: string

The ID of the media stream pipeline

Sinks
Type: Array of MediaStreamSink structures

The media stream pipeline's data sinks.

Sources
Type: Array of MediaStreamSource structures

The media stream pipeline's data sources.

Status
Type: string

The status of the media stream pipeline.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which the media stream pipeline was updated.

MediaStreamSink

Description

Structure that contains the settings for a media stream sink.

Members
MediaStreamType
Required: Yes
Type: string

The media stream sink's media stream type.

ReservedStreamCapacity
Required: Yes
Type: int

Specifies the number of streams that the sink can accept.

SinkArn
Required: Yes
Type: string

The ARN of the Kinesis Video Stream pool returned by the CreateMediaPipelineKinesisVideoStreamPool API.

SinkType
Required: Yes
Type: string

The media stream sink's type.

MediaStreamSource

Description

Structure that contains the settings for media stream sources.

Members
SourceArn
Required: Yes
Type: string

The ARN of the meeting.

SourceType
Required: Yes
Type: string

The type of media stream source.

MeetingEventsConcatenationConfiguration

Description

The configuration object for an event concatenation pipeline.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

NotFoundException

Description

One or more of the resources in the request does not exist in the system.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

PostCallAnalyticsSettings

Description

Allows you to specify additional settings for your Call Analytics post-call request, including output locations for your redacted transcript, which IAM role to use, and which encryption key to use.

DataAccessRoleArn and OutputLocation are required fields.

PostCallAnalyticsSettings provides the same insights as a Call Analytics post-call transcription. For more information, refer to Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

Members
ContentRedactionOutput
Type: string

The content redaction output settings for a post-call analysis task.

DataAccessRoleArn
Required: Yes
Type: string

The ARN of the role used by Amazon Web Services Transcribe to upload your post call analysis. For more information, see Post-call analytics with real-time transcriptions in the Amazon Transcribe Developer Guide.

OutputEncryptionKMSKeyId
Type: string

The ID of the KMS (Key Management Service) key used to encrypt the output.

OutputLocation
Required: Yes
Type: string

The URL of the Amazon S3 bucket that contains the post-call data.

PresenterOnlyConfiguration

Description

Defines the configuration for a presenter-only video tile.

Members
PresenterPosition
Type: string

Defines the position of the presenter video tile. Default: TopRight.

RealTimeAlertConfiguration

Description

A structure that contains the configuration settings for real-time alerts.

Members
Disabled
Type: boolean

Turns off real-time alerts.

Rules
Type: Array of RealTimeAlertRule structures

The rules in the alert. Rules specify the words or phrases that you want to be notified about.

RealTimeAlertRule

Description

Specifies the words or phrases that trigger an alert.

Members
IssueDetectionConfiguration
Type: IssueDetectionConfiguration structure

Specifies the issue detection settings for a real-time alert rule.

KeywordMatchConfiguration
Type: KeywordMatchConfiguration structure

Specifies the settings for matching the keywords in a real-time alert rule.

SentimentConfiguration
Type: SentimentConfiguration structure

Specifies the settings for predicting sentiment in a real-time alert rule.

Type
Required: Yes
Type: string

The type of alert rule.

RecordingStreamConfiguration

Description

A structure that holds the settings for recording media.

Members
StreamArn
Type: string

The ARN of the recording stream.

ResourceLimitExceededException

Description

The request exceeds the resource limit.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

S3BucketSinkConfiguration

Description

The configuration settings for the S3 bucket.

Members
Destination
Required: Yes
Type: string

The destination URL of the S3 bucket.

S3RecordingSinkConfiguration

Description

The structure that holds the settings for transmitting media to the Amazon S3 bucket. These values are used as defaults if S3RecordingSinkRuntimeConfiguration is not specified.

Members
Destination
Type: string

The default URI of the Amazon S3 bucket used as the recording sink.

RecordingFileFormat
Type: string

The default file format for the media files sent to the Amazon S3 bucket.

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.

Members
Destination
Required: Yes
Type: string

The URI of the S3 bucket used as the sink.

RecordingFileFormat
Required: Yes
Type: string

The file format for the media files sent to the Amazon S3 bucket.

SelectedVideoStreams

Description

The video streams for a specified media pipeline. The total number of video streams can't exceed 25.

Members
AttendeeIds
Type: Array of strings

The attendee IDs of the streams selected for a media pipeline.

ExternalUserIds
Type: Array of strings

The external user IDs of the streams selected for a media pipeline.

SentimentConfiguration

Description

A structure that contains the configuration settings for a sentiment analysis task.

Members
RuleName
Required: Yes
Type: string

The name of the rule in the sentiment configuration.

SentimentType
Required: Yes
Type: string

The type of sentiment, POSITIVE, NEGATIVE, or NEUTRAL.

TimePeriod
Required: Yes
Type: int

Specifies the analysis interval.

ServiceFailureException

Description

The service encountered an unexpected error.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

ServiceUnavailableException

Description

The service is currently unavailable.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

SnsTopicSinkConfiguration

Description

The configuration settings for the SNS topic sink.

Members
InsightsTarget
Type: string

The ARN of the SNS sink.

SourceConfiguration

Description

Source configuration for a specified media pipeline.

Members
SelectedVideoStreams
Type: SelectedVideoStreams structure

The selected video streams for a specified media pipeline. The number of video streams can't exceed 25.

SpeakerSearchTask

Description

A representation of an asynchronous request to perform speaker search analysis on a media insights pipeline.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a speaker search task was created.

SpeakerSearchTaskId
Type: string

The speaker search task ID.

SpeakerSearchTaskStatus
Type: string

The status of the speaker search task.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a speaker search task was updated.

SqsQueueSinkConfiguration

Description

The configuration settings for the SQS sink.

Members
InsightsTarget
Type: string

The ARN of the SQS sink.

StreamChannelDefinition

Description

Defines a streaming channel.

Members
ChannelDefinitions
Type: Array of ChannelDefinition structures

The definitions of the channels in a streaming channel.

NumberOfChannels
Required: Yes
Type: int

The number of channels in a streaming channel.

StreamConfiguration

Description

The configuration settings for a stream.

Members
FragmentNumber
Type: string

The unique identifier of the fragment to begin processing.

StreamArn
Required: Yes
Type: string

The ARN of the stream.

StreamChannelDefinition
Required: Yes
Type: StreamChannelDefinition structure

The streaming channel definition in the stream configuration.

Tag

Description

A key/value pair that grants users access to meeting resources.

Members
Key
Required: Yes
Type: string

The key half of a tag.

Value
Required: Yes
Type: string

The value half of a tag.

ThrottledClientException

Description

The client exceeded its request rate limit.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

TimestampRange

Description

The range of timestamps to return.

Members
EndTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The ending timestamp for the specified range.

StartTimestamp
Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

The starting timestamp for the specified range.

TranscriptionMessagesConcatenationConfiguration

Description

The configuration object for concatenating transcription messages.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

UnauthorizedClientException

Description

The client is not currently authorized to make the request.

Members
Code
Type: string
Message
Type: string
RequestId
Type: string

The request ID associated with the call responsible for the exception.

VerticalLayoutConfiguration

Description

Defines the configuration settings for a vertical layout.

Members
TileAspectRatio
Type: string

Sets the aspect ratio of the video tiles, such as 16:9.

TileCount
Type: int

The maximum number of tiles to display.

TileOrder
Type: string

Sets the automatic ordering of the video tiles.

TilePosition
Type: string

Sets the position of vertical tiles.

VideoArtifactsConfiguration

Description

The video artifact configuration object.

Members
MuxType
Type: string

The MUX type of the video artifact configuration object.

State
Required: Yes
Type: string

Indicates whether the video artifact is enabled or disabled.

VideoAttribute

Description

Defines the settings for a video tile.

Members
BorderColor
Type: string

Defines the border color of all video tiles.

BorderThickness
Type: int

Defines the border thickness for all video tiles.

CornerRadius
Type: int

Sets the corner radius of all video tiles.

HighlightColor
Type: string

Defines the highlight color for the active video tile.

VideoConcatenationConfiguration

Description

The configuration object of a video concatenation pipeline.

Members
State
Required: Yes
Type: string

Enables or disables the configuration object.

VoiceAnalyticsProcessorConfiguration

Description

The configuration settings for a voice analytics processor.

Members
SpeakerSearchStatus
Type: string

The status of the speaker search task.

VoiceToneAnalysisStatus
Type: string

The status of the voice tone analysis task.

VoiceEnhancementSinkConfiguration

Description

A static structure that contains the configuration data for a VoiceEnhancementSinkConfiguration element.

Members
Disabled
Type: boolean

Disables the VoiceEnhancementSinkConfiguration element.

VoiceToneAnalysisTask

Description

A representation of an asynchronous request to perform voice tone analysis on a media insights pipeline.

Members
CreatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice tone analysis task was created.

UpdatedTimestamp
Type: timestamp (string|DateTime or anything parsable by strtotime)

The time at which a voice tone analysis task was updated.

VoiceToneAnalysisTaskId
Type: string

The ID of the voice tone analysis task.

VoiceToneAnalysisTaskStatus
Type: string

The status of a voice tone analysis task.