|
48 | 48 | {"shape":"ThrottlingException"},
|
49 | 49 | {"shape":"AccessDeniedException"}
|
50 | 50 | ],
|
51 |
| - "documentation":"<p>Deletes the specified domain from Voice ID.</p>" |
| 51 | + "documentation":"<p>Deletes the specified domain from Voice ID.</p>", |
| 52 | + "idempotent":true |
52 | 53 | },
|
53 | 54 | "DeleteFraudster":{
|
54 | 55 | "name":"DeleteFraudster",
|
|
280 | 281 | "input":{"shape":"OptOutSpeakerRequest"},
|
281 | 282 | "output":{"shape":"OptOutSpeakerResponse"},
|
282 | 283 | "errors":[
|
| 284 | + {"shape":"ServiceQuotaExceededException"}, |
283 | 285 | {"shape":"ResourceNotFoundException"},
|
284 | 286 | {"shape":"ValidationException"},
|
285 | 287 | {"shape":"ConflictException"},
|
|
509 | 511 | },
|
510 | 512 | "Description":{
|
511 | 513 | "shape":"Description",
|
512 |
| - "documentation":"<p>A brief description of this domain.</p>" |
| 514 | + "documentation":"<p>A brief description of the domain.</p>" |
513 | 515 | },
|
514 | 516 | "Name":{
|
515 | 517 | "shape":"DomainName",
|
|
815 | 817 | },
|
816 | 818 | "ServerSideEncryptionUpdateDetails":{
|
817 | 819 | "shape":"ServerSideEncryptionUpdateDetails",
|
818 |
| - "documentation":"<p>Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain’s data can only be accessed using the new KMS key.</p>" |
| 820 | + "documentation":"<p>Details about the most recent server-side encryption configuration update. When the server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is complete, the domain's data can only be accessed using the new KMS key.</p>" |
819 | 821 | },
|
820 | 822 | "UpdatedAt":{
|
821 | 823 | "shape":"Timestamp",
|
|
954 | 956 | },
|
955 | 957 | "FraudDetectionReason":{
|
956 | 958 | "type":"string",
|
957 |
| - "enum":["KNOWN_FRAUDSTER"] |
| 959 | + "enum":[ |
| 960 | + "KNOWN_FRAUDSTER", |
| 961 | + "VOICE_SPOOFING" |
| 962 | + ] |
958 | 963 | },
|
959 | 964 | "FraudDetectionReasons":{
|
960 | 965 | "type":"list",
|
|
987 | 992 | },
|
988 | 993 | "Reasons":{
|
989 | 994 | "shape":"FraudDetectionReasons",
|
990 |
| - "documentation":"<p>The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is <code>HIGH_RISK</code>, and only has one possible value: <code>KNOWN_FRAUDSTER</code>.</p>" |
| 995 | + "documentation":"<p>The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is <code>HIGH_RISK</code>, and the following possible values: <code>KNOWN_FRAUDSTER</code> and <code>VOICE_SPOOFING</code>.</p>" |
991 | 996 | },
|
992 | 997 | "RiskDetails":{
|
993 | 998 | "shape":"FraudRiskDetails",
|
994 |
| - "documentation":"<p>Details about each risk analyzed for this speaker.</p>" |
| 999 | + "documentation":"<p>Details about each risk analyzed for this speaker. Currently, this contains KnownFraudsterRisk and VoiceSpoofingRisk details.</p>" |
995 | 1000 | }
|
996 | 1001 | },
|
997 | 1002 | "documentation":"<p>The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.</p>"
|
998 | 1003 | },
|
999 | 1004 | "FraudRiskDetails":{
|
1000 | 1005 | "type":"structure",
|
1001 |
| - "required":["KnownFraudsterRisk"], |
| 1006 | + "required":[ |
| 1007 | + "KnownFraudsterRisk", |
| 1008 | + "VoiceSpoofingRisk" |
| 1009 | + ], |
1002 | 1010 | "members":{
|
1003 | 1011 | "KnownFraudsterRisk":{
|
1004 | 1012 | "shape":"KnownFraudsterRisk",
|
1005 | 1013 | "documentation":"<p>The details resulting from 'Known Fraudster Risk' analysis of the speaker.</p>"
|
| 1014 | + }, |
| 1015 | + "VoiceSpoofingRisk":{ |
| 1016 | + "shape":"VoiceSpoofingRisk", |
| 1017 | + "documentation":"<p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>" |
1006 | 1018 | }
|
1007 | 1019 | },
|
1008 | 1020 | "documentation":"<p>Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.</p>"
|
|
1077 | 1089 | },
|
1078 | 1090 | "OutputDataConfig":{
|
1079 | 1091 | "shape":"OutputDataConfig",
|
1080 |
| - "documentation":"<p>The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key iD in order to encrypt the file.</p>" |
| 1092 | + "documentation":"<p>The output data config containing the S3 location where you want Voice ID to write your job output file; you must also include a KMS key ID in order to encrypt the file.</p>" |
1081 | 1093 | },
|
1082 | 1094 | "RegistrationConfig":{
|
1083 | 1095 | "shape":"RegistrationConfig",
|
|
1125 | 1137 | },
|
1126 | 1138 | "JobName":{
|
1127 | 1139 | "shape":"JobName",
|
1128 |
| - "documentation":"<p>The client-provied name for the fraudster registration job.</p>" |
| 1140 | + "documentation":"<p>The client-provided name for the fraudster registration job.</p>" |
1129 | 1141 | },
|
1130 | 1142 | "JobProgress":{
|
1131 | 1143 | "shape":"JobProgress",
|
|
1228 | 1240 | "members":{
|
1229 | 1241 | "MaxResults":{
|
1230 | 1242 | "shape":"MaxResultsForListDomainFe",
|
1231 |
| - "documentation":"<p>The maximum number of results that are returned per call. You can use <code>NextToken</code> to obtain further pages of results. The default is 100; the maximum allowed page size is also 100. </p>" |
| 1243 | + "documentation":"<p>The maximum number of domains to list per API call.</p>" |
1232 | 1244 | },
|
1233 | 1245 | "NextToken":{
|
1234 | 1246 | "shape":"NextToken",
|
|
1419 | 1431 | "members":{
|
1420 | 1432 | "KmsKeyId":{
|
1421 | 1433 | "shape":"KmsKeyId",
|
1422 |
| - "documentation":"<p>the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.</p>" |
| 1434 | + "documentation":"<p>The identifier of the KMS key you want Voice ID to use to encrypt the output file of a speaker enrollment job/fraudster registration job. </p>" |
1423 | 1435 | },
|
1424 | 1436 | "S3Uri":{
|
1425 | 1437 | "shape":"S3Uri",
|
|
1483 | 1495 | "members":{
|
1484 | 1496 | "KmsKeyId":{
|
1485 | 1497 | "shape":"KmsKeyId",
|
1486 |
| - "documentation":"<p>The identifier of the KMS key you want Voice ID to use to encrypt your data.</p>" |
| 1498 | + "documentation":"<p>The identifier of the KMS key to use to encrypt data stored by Voice ID. Voice ID doesn't support asymmetric customer managed keys. </p>" |
1487 | 1499 | }
|
1488 | 1500 | },
|
1489 | 1501 | "documentation":"<p>The configuration containing information about the customer managed key used for encrypting customer data.</p>"
|
|
1770 | 1782 | },
|
1771 | 1783 | "RegistrationConfig":{
|
1772 | 1784 | "shape":"RegistrationConfig",
|
1773 |
| - "documentation":"<p>The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster.</p>" |
| 1785 | + "documentation":"<p>The registration config containing details such as the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster. </p>" |
1774 | 1786 | }
|
1775 | 1787 | }
|
1776 | 1788 | },
|
|
1799 | 1811 | },
|
1800 | 1812 | "DataAccessRoleArn":{
|
1801 | 1813 | "shape":"IamRoleArn",
|
1802 |
| - "documentation":"<p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html\">Batch enrollment using audio data from prior calls</a> documentation for the permissions needed in this role.</p>" |
| 1814 | + "documentation":"<p>The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets to read the input manifest file and write the job output file. Refer to <a href=\"https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html\">Batch enrollment using audio data from prior calls</a> for the permissions needed in this role.</p>" |
1803 | 1815 | },
|
1804 | 1816 | "DomainId":{
|
1805 | 1817 | "shape":"DomainId",
|
|
1853 | 1865 | "members":{
|
1854 | 1866 | "Key":{
|
1855 | 1867 | "shape":"TagKey",
|
1856 |
| - "documentation":"<p>The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the key is 'Department'. </p>" |
| 1868 | + "documentation":"<p>The first part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the key is 'Department'. </p>" |
1857 | 1869 | },
|
1858 | 1870 | "Value":{
|
1859 | 1871 | "shape":"TagValue",
|
1860 |
| - "documentation":"<p>The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag ‘Department’:’Sales’, the value is 'Sales'. </p>" |
| 1872 | + "documentation":"<p>The second part of a key:value pair that forms a tag associated with a given resource. For example, in the tag 'Department':'Sales', the value is 'Sales'. </p>" |
1861 | 1873 | }
|
1862 | 1874 | },
|
1863 |
| - "documentation":"<p>A tag that can be assigned to a Voice ID resource.</p>" |
| 1875 | + "documentation":"<p>The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.</p>" |
1864 | 1876 | },
|
1865 | 1877 | "TagKey":{
|
1866 | 1878 | "type":"string",
|
|
1957 | 1969 | "members":{
|
1958 | 1970 | "Description":{
|
1959 | 1971 | "shape":"Description",
|
1960 |
| - "documentation":"<p>A brief description about this domain.</p>" |
| 1972 | + "documentation":"<p>A brief description of the domain.</p>" |
1961 | 1973 | },
|
1962 | 1974 | "DomainId":{
|
1963 | 1975 | "shape":"DomainId",
|
|
1969 | 1981 | },
|
1970 | 1982 | "ServerSideEncryptionConfiguration":{
|
1971 | 1983 | "shape":"ServerSideEncryptionConfiguration",
|
1972 |
| - "documentation":"<p>The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Note that all the existing data in the domain are still encrypted using the existing key, only the data added to domain after updating the key is encrypted using the new key. </p>" |
| 1984 | + "documentation":"<p>The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side encryption of your data. Changing the domain's associated KMS key immediately triggers an asynchronous process to remove dependency on the old KMS key, such that the domain's data can only be accessed using the new KMS key. The domain's <code>ServerSideEncryptionUpdateDetails</code> contains the details for this process.</p>" |
1973 | 1985 | }
|
1974 | 1986 | }
|
1975 | 1987 | },
|
|
1989 | 2001 | },
|
1990 | 2002 | "documentation":"<p>The request failed one or more validations; check the error message for more details.</p>",
|
1991 | 2003 | "exception":true
|
| 2004 | + }, |
| 2005 | + "VoiceSpoofingRisk":{ |
| 2006 | + "type":"structure", |
| 2007 | + "required":["RiskScore"], |
| 2008 | + "members":{ |
| 2009 | + "RiskScore":{ |
| 2010 | + "shape":"Score", |
| 2011 | + "documentation":"<p>The score indicating the likelihood of speaker’s voice being spoofed.</p>" |
| 2012 | + } |
| 2013 | + }, |
| 2014 | + "documentation":"<p>The details resulting from 'Voice Spoofing Risk' analysis of the speaker.</p>" |
1992 | 2015 | }
|
1993 | 2016 | },
|
1994 | 2017 | "documentation":"<p>Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service. </p>"
|
|
0 commit comments