AWS API Changes

2023/03/23 - Amazon Chime SDK Voice - 19 new 2 updated api methods

Changes This release adds Amazon Chime SDK call analytics. Call analytics include voice analytics, which provides speaker search and voice tone analysis. These capabilities can be used with Amazon Transcribe and Transcribe Call Analytics to generate machine-learning-powered insights from real-time audio.

StopSpeakerSearchTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

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

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
type SpeakerSearchTaskId: string
param SpeakerSearchTaskId: [REQUIRED]
returns: None

CreateVoiceProfileDomain (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_voice_profile_domain(
    Name='string',
    Description='string',
    ServerSideEncryptionConfiguration={
        'KmsKeyArn': 'string'
    },
    ClientRequestToken='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type Name

string

param Name

[REQUIRED]

type Description

string

param Description

type ServerSideEncryptionConfiguration

dict

param ServerSideEncryptionConfiguration

[REQUIRED]

KmsKeyArn (string) -- [REQUIRED]

type ClientRequestToken

string

param ClientRequestToken

type Tags

list

param Tags

(dict) --
- Key (string) -- [REQUIRED]
- Value (string) -- [REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceProfileDomain': {
        'VoiceProfileDomainId': 'string',
        'VoiceProfileDomainArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'ServerSideEncryptionConfiguration': {
            'KmsKeyArn': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfileDomain (dict) --
  - VoiceProfileDomainId (string) --
  - VoiceProfileDomainArn (string) --
  - Name (string) --
  - Description (string) --
  - ServerSideEncryptionConfiguration (dict) --
    - KmsKeyArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

DeleteVoiceProfile (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_profile(
    VoiceProfileId='string'
)

type VoiceProfileId: string
param VoiceProfileId: [REQUIRED]
returns: None

DeleteVoiceProfileDomain (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.delete_voice_profile_domain(
    VoiceProfileDomainId='string'
)

type VoiceProfileDomainId: string
param VoiceProfileDomainId: [REQUIRED]
returns: None

GetVoiceProfileDomain (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_profile_domain(
    VoiceProfileDomainId='string'
)

type VoiceProfileDomainId

string

param VoiceProfileDomainId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceProfileDomain': {
        'VoiceProfileDomainId': 'string',
        'VoiceProfileDomainArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'ServerSideEncryptionConfiguration': {
            'KmsKeyArn': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfileDomain (dict) --
  - VoiceProfileDomainId (string) --
  - VoiceProfileDomainArn (string) --
  - Name (string) --
  - Description (string) --
  - ServerSideEncryptionConfiguration (dict) --
    - KmsKeyArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

UntagResource (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    ResourceARN='string',
    TagKeys=[
        'string',
    ]
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

type TagKeys

list

param TagKeys

[REQUIRED]

(string) --

returns

None

StartSpeakerSearchTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.start_speaker_search_task(
    VoiceConnectorId='string',
    TransactionId='string',
    VoiceProfileDomainId='string',
    ClientRequestToken='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type TransactionId

string

param TransactionId

[REQUIRED]

type VoiceProfileDomainId

string

param VoiceProfileDomainId

[REQUIRED]

type ClientRequestToken

string

param ClientRequestToken

rtype

dict

returns

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'SpeakerSearchDetails': {
            'Results': [
                {
                    'ConfidenceScore': ...,
                    'VoiceProfileId': 'string'
                },
            ],
            'VoiceprintGenerationStatus': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- SpeakerSearchTask (dict) --
  - SpeakerSearchTaskId (string) --
  - SpeakerSearchTaskStatus (string) --
  - CallDetails (dict) --
    - VoiceConnectorId (string) --
    - TransactionId (string) --
    - IsCaller (boolean) --
  - SpeakerSearchDetails (dict) --
    - Results (list) --
      - (dict) --
        
        ConfidenceScore (float) --
        
        VoiceProfileId (string) --
    - VoiceprintGenerationStatus (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - StartedTimestamp (datetime) --
  - StatusMessage (string) --

UpdateVoiceProfile (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_voice_profile(
    VoiceProfileId='string',
    SpeakerSearchTaskId='string'
)

type VoiceProfileId

string

param VoiceProfileId

[REQUIRED]

type SpeakerSearchTaskId

string

param SpeakerSearchTaskId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceProfile': {
        'VoiceProfileId': 'string',
        'VoiceProfileArn': 'string',
        'VoiceProfileDomainId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfile (dict) --
  - VoiceProfileId (string) --
  - VoiceProfileArn (string) --
  - VoiceProfileDomainId (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - ExpirationTimestamp (datetime) --

CreateVoiceProfile (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.create_voice_profile(
    SpeakerSearchTaskId='string'
)

type SpeakerSearchTaskId

string

param SpeakerSearchTaskId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceProfile': {
        'VoiceProfileId': 'string',
        'VoiceProfileArn': 'string',
        'VoiceProfileDomainId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfile (dict) --
  - VoiceProfileId (string) --
  - VoiceProfileArn (string) --
  - VoiceProfileDomainId (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - ExpirationTimestamp (datetime) --

ListVoiceProfileDomains (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_voice_profile_domains(
    NextToken='string',
    MaxResults=123
)

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'VoiceProfileDomains': [
        {
            'VoiceProfileDomainId': 'string',
            'VoiceProfileDomainArn': 'string',
            'Name': 'string',
            'Description': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceProfileDomains (list) --
  - (dict) --
    - VoiceProfileDomainId (string) --
    - VoiceProfileDomainArn (string) --
    - Name (string) --
    - Description (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
- NextToken (string) --

GetVoiceToneAnalysisTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_tone_analysis_task(
    VoiceConnectorId='string',
    VoiceToneAnalysisTaskId='string',
    IsCaller=True|False
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type VoiceToneAnalysisTaskId

string

param VoiceToneAnalysisTaskId

[REQUIRED]

type IsCaller

boolean

param IsCaller

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- VoiceToneAnalysisTask (dict) --
  - VoiceToneAnalysisTaskId (string) --
  - VoiceToneAnalysisTaskStatus (string) --
  - CallDetails (dict) --
    - VoiceConnectorId (string) --
    - TransactionId (string) --
    - IsCaller (boolean) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - StartedTimestamp (datetime) --
  - StatusMessage (string) --

GetVoiceProfile (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.get_voice_profile(
    VoiceProfileId='string'
)

type VoiceProfileId

string

param VoiceProfileId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'VoiceProfile': {
        'VoiceProfileId': 'string',
        'VoiceProfileArn': 'string',
        'VoiceProfileDomainId': 'string',
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'ExpirationTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfile (dict) --
  - VoiceProfileId (string) --
  - VoiceProfileArn (string) --
  - VoiceProfileDomainId (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - ExpirationTimestamp (datetime) --

ListVoiceProfiles (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_voice_profiles(
    VoiceProfileDomainId='string',
    NextToken='string',
    MaxResults=123
)

type VoiceProfileDomainId

string

param VoiceProfileDomainId

[REQUIRED]

type NextToken

string

param NextToken

type MaxResults

integer

param MaxResults

rtype

dict

returns

Response Syntax

{
    'VoiceProfiles': [
        {
            'VoiceProfileId': 'string',
            'VoiceProfileArn': 'string',
            'VoiceProfileDomainId': 'string',
            'CreatedTimestamp': datetime(2015, 1, 1),
            'UpdatedTimestamp': datetime(2015, 1, 1),
            'ExpirationTimestamp': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) --
- VoiceProfiles (list) --
  - (dict) --
    - VoiceProfileId (string) --
    - VoiceProfileArn (string) --
    - VoiceProfileDomainId (string) --
    - CreatedTimestamp (datetime) --
    - UpdatedTimestamp (datetime) --
    - ExpirationTimestamp (datetime) --
- NextToken (string) --

TagResource (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    ResourceARN='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

type Tags

list

param Tags

[REQUIRED]

(dict) --
- Key (string) -- [REQUIRED]
- Value (string) -- [REQUIRED]

returns

None

StartVoiceToneAnalysisTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.start_voice_tone_analysis_task(
    VoiceConnectorId='string',
    TransactionId='string',
    LanguageCode='en-US',
    ClientRequestToken='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type TransactionId

string

param TransactionId

[REQUIRED]

type LanguageCode

string

param LanguageCode

[REQUIRED]

type ClientRequestToken

string

param ClientRequestToken

rtype

dict

returns

Response Syntax

{
    'VoiceToneAnalysisTask': {
        'VoiceToneAnalysisTaskId': 'string',
        'VoiceToneAnalysisTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- VoiceToneAnalysisTask (dict) --
  - VoiceToneAnalysisTaskId (string) --
  - VoiceToneAnalysisTaskStatus (string) --
  - CallDetails (dict) --
    - VoiceConnectorId (string) --
    - TransactionId (string) --
    - IsCaller (boolean) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - StartedTimestamp (datetime) --
  - StatusMessage (string) --

GetSpeakerSearchTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

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

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type SpeakerSearchTaskId

string

param SpeakerSearchTaskId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'SpeakerSearchTask': {
        'SpeakerSearchTaskId': 'string',
        'SpeakerSearchTaskStatus': 'string',
        'CallDetails': {
            'VoiceConnectorId': 'string',
            'TransactionId': 'string',
            'IsCaller': True|False
        },
        'SpeakerSearchDetails': {
            'Results': [
                {
                    'ConfidenceScore': ...,
                    'VoiceProfileId': 'string'
                },
            ],
            'VoiceprintGenerationStatus': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1),
        'StartedTimestamp': datetime(2015, 1, 1),
        'StatusMessage': 'string'
    }
}

Response Structure

(dict) --
- SpeakerSearchTask (dict) --
  - SpeakerSearchTaskId (string) --
  - SpeakerSearchTaskStatus (string) --
  - CallDetails (dict) --
    - VoiceConnectorId (string) --
    - TransactionId (string) --
    - IsCaller (boolean) --
  - SpeakerSearchDetails (dict) --
    - Results (list) --
      - (dict) --
        
        ConfidenceScore (float) --
        
        VoiceProfileId (string) --
    - VoiceprintGenerationStatus (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --
  - StartedTimestamp (datetime) --
  - StatusMessage (string) --

UpdateVoiceProfileDomain (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.update_voice_profile_domain(
    VoiceProfileDomainId='string',
    Name='string',
    Description='string'
)

type VoiceProfileDomainId

string

param VoiceProfileDomainId

[REQUIRED]

type Name

string

param Name

type Description

string

param Description

rtype

dict

returns

Response Syntax

{
    'VoiceProfileDomain': {
        'VoiceProfileDomainId': 'string',
        'VoiceProfileDomainArn': 'string',
        'Name': 'string',
        'Description': 'string',
        'ServerSideEncryptionConfiguration': {
            'KmsKeyArn': 'string'
        },
        'CreatedTimestamp': datetime(2015, 1, 1),
        'UpdatedTimestamp': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) --
- VoiceProfileDomain (dict) --
  - VoiceProfileDomainId (string) --
  - VoiceProfileDomainArn (string) --
  - Name (string) --
  - Description (string) --
  - ServerSideEncryptionConfiguration (dict) --
    - KmsKeyArn (string) --
  - CreatedTimestamp (datetime) --
  - UpdatedTimestamp (datetime) --

ListTagsForResource (new)

Link ¶

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    ResourceARN='string'
)

type ResourceARN

string

param ResourceARN

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'Tags': [
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
}

Response Structure

(dict) --
- Tags (list) --
  - (dict) --
    - Key (string) --
    - Value (string) --

StopVoiceToneAnalysisTask (new)

Link ¶

See also: AWS API Documentation

Request Syntax

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

type VoiceConnectorId: string
param VoiceConnectorId: [REQUIRED]
type VoiceToneAnalysisTaskId: string
param VoiceToneAnalysisTaskId: [REQUIRED]
returns: None

GetVoiceConnectorStreamingConfiguration (updated)

Link ¶
Changes (response)

{'StreamingConfiguration': {'MediaInsightsConfiguration': {'ConfigurationArn': 'string',
                                                           'Disabled': 'boolean'}}}

See also: AWS API Documentation

Request Syntax

client.get_voice_connector_streaming_configuration(
    VoiceConnectorId='string'
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ],
        'MediaInsightsConfiguration': {
            'Disabled': True|False,
            'ConfigurationArn': 'string'
        }
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  - DataRetentionInHours (integer) --
  - Disabled (boolean) --
  - StreamingNotificationTargets (list) --
    - (dict) --
      - NotificationTarget (string) --
  - MediaInsightsConfiguration (dict) --
    - Disabled (boolean) --
    - ConfigurationArn (string) --

PutVoiceConnectorStreamingConfiguration (updated)

Link ¶
Changes (both)

{'StreamingConfiguration': {'MediaInsightsConfiguration': {'ConfigurationArn': 'string',
                                                           'Disabled': 'boolean'}}}

See also: AWS API Documentation

Request Syntax

client.put_voice_connector_streaming_configuration(
    VoiceConnectorId='string',
    StreamingConfiguration={
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ],
        'MediaInsightsConfiguration': {
            'Disabled': True|False,
            'ConfigurationArn': 'string'
        }
    }
)

type VoiceConnectorId

string

param VoiceConnectorId

[REQUIRED]

type StreamingConfiguration

dict

param StreamingConfiguration

[REQUIRED]

DataRetentionInHours (integer) -- [REQUIRED]
Disabled (boolean) -- [REQUIRED]
StreamingNotificationTargets (list) --
- (dict) --
  - NotificationTarget (string) --
MediaInsightsConfiguration (dict) --
- Disabled (boolean) --
- ConfigurationArn (string) --

rtype

dict

returns

Response Syntax

{
    'StreamingConfiguration': {
        'DataRetentionInHours': 123,
        'Disabled': True|False,
        'StreamingNotificationTargets': [
            {
                'NotificationTarget': 'EventBridge'|'SNS'|'SQS'
            },
        ],
        'MediaInsightsConfiguration': {
            'Disabled': True|False,
            'ConfigurationArn': 'string'
        }
    }
}

Response Structure

(dict) --
- StreamingConfiguration (dict) --
  - DataRetentionInHours (integer) --
  - Disabled (boolean) --
  - StreamingNotificationTargets (list) --
    - (dict) --
      - NotificationTarget (string) --
  - MediaInsightsConfiguration (dict) --
    - Disabled (boolean) --
    - ConfigurationArn (string) --