Amazon Chime SDK Media Pipelines

Stops a voice tone analysis task.

See also: AWS API Documentation

Request Syntax

client.stop_voice_tone_analysis_task(
    Identifier='string',
    VoiceToneAnalysisTaskId='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type VoiceToneAnalysisTaskId:

string

param VoiceToneAnalysisTaskId:

[REQUIRED]

The ID of the voice tone analysis task.

returns:

None

Stops a speaker search task.

See also: AWS API Documentation

Request Syntax

client.stop_speaker_search_task(
    Identifier='string',
    SpeakerSearchTaskId='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type SpeakerSearchTaskId:

string

param SpeakerSearchTaskId:

[REQUIRED]

The speaker search task ID.

returns:

None

Starts a speaker search task.

See also: AWS API Documentation

Request Syntax

client.start_speaker_search_task(
    Identifier='string',
    VoiceProfileDomainArn='string',
    KinesisVideoStreamSourceTaskConfiguration={
        'StreamArn': 'string',
        'ChannelId': 123,
        'FragmentNumber': 'string'
    },
    ClientRequestToken='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type VoiceProfileDomainArn:

string

param VoiceProfileDomainArn:

[REQUIRED]

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

type KinesisVideoStreamSourceTaskConfiguration:

dict

param KinesisVideoStreamSourceTaskConfiguration:

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

• StreamArn (string) -- [REQUIRED]

  The ARN of the stream.

• ChannelId (integer) -- [REQUIRED]

  The channel ID.

• FragmentNumber (string) --

  The unique identifier of the fragment to begin processing.

type ClientRequestToken:

string

param ClientRequestToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • SpeakerSearchTask (dict) --

    The details of the speaker search task.

    • SpeakerSearchTaskId (string) --

      The speaker search task ID.

    • SpeakerSearchTaskStatus (string) --

      The status of the speaker search task.

    • CreatedTimestamp (datetime) --

      The time at which a speaker search task was created.

    • UpdatedTimestamp (datetime) --

      The time at which a speaker search task was updated.

Retrieves the details of the specified speaker search task.

See also: AWS API Documentation

Request Syntax

client.get_speaker_search_task(
    Identifier='string',
    SpeakerSearchTaskId='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type SpeakerSearchTaskId:

string

param SpeakerSearchTaskId:

[REQUIRED]

The ID of the speaker search task.

rtype:

dict

returns:

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • SpeakerSearchTask (dict) --

    The details of the speaker search task.

    • SpeakerSearchTaskId (string) --

      The speaker search task ID.

    • SpeakerSearchTaskStatus (string) --

      The status of the speaker search task.

    • CreatedTimestamp (datetime) --

      The time at which a speaker search task was created.

    • UpdatedTimestamp (datetime) --

      The time at which a speaker search task was updated.

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.

See also: AWS API Documentation

Request Syntax

client.start_voice_tone_analysis_task(
    Identifier='string',
    LanguageCode='en-US',
    KinesisVideoStreamSourceTaskConfiguration={
        'StreamArn': 'string',
        'ChannelId': 123,
        'FragmentNumber': 'string'
    },
    ClientRequestToken='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type LanguageCode:

string

param LanguageCode:

[REQUIRED]

The language code.

type KinesisVideoStreamSourceTaskConfiguration:

dict

param KinesisVideoStreamSourceTaskConfiguration:

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

• StreamArn (string) -- [REQUIRED]

  The ARN of the stream.

• ChannelId (integer) -- [REQUIRED]

  The channel ID.

• FragmentNumber (string) --

  The unique identifier of the fragment to begin processing.

type ClientRequestToken:

string

param ClientRequestToken:

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

This field is autopopulated if not provided.

rtype:

dict

returns:

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • VoiceToneAnalysisTask (dict) --

    The details of the voice tone analysis task.

    • VoiceToneAnalysisTaskId (string) --

      The ID of the voice tone analysis task.

    • VoiceToneAnalysisTaskStatus (string) --

      The status of a voice tone analysis task.

    • CreatedTimestamp (datetime) --

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

    • UpdatedTimestamp (datetime) --

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

Retrieves the details of a voice tone analysis task.

See also: AWS API Documentation

Request Syntax

client.get_voice_tone_analysis_task(
    Identifier='string',
    VoiceToneAnalysisTaskId='string'
)

type Identifier:

string

param Identifier:

[REQUIRED]

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

type VoiceToneAnalysisTaskId:

string

param VoiceToneAnalysisTaskId:

[REQUIRED]

The ID of the voice tone anlysis task.

rtype:

dict

returns:

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'NotStarted'|'Initializing'|'InProgress'|'Failed'|'Stopping'|'Stopped',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

• (dict) --

  • VoiceToneAnalysisTask (dict) --

    The details of the voice tone analysis task.

    • VoiceToneAnalysisTaskId (string) --

      The ID of the voice tone analysis task.

    • VoiceToneAnalysisTaskStatus (string) --

      The status of a voice tone analysis task.

    • CreatedTimestamp (datetime) --

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

    • UpdatedTimestamp (datetime) --

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