diff --git a/codegen/sdk-codegen/aws-models/fsx.json b/codegen/sdk-codegen/aws-models/fsx.json index f477e31a8be..ea48eae69fb 100644 --- a/codegen/sdk-codegen/aws-models/fsx.json +++ b/codegen/sdk-codegen/aws-models/fsx.json @@ -1894,7 +1894,7 @@ "SecurityStyle": { "target": "com.amazonaws.fsx#SecurityStyle", "traits": { - "smithy.api#documentation": "

The security style for the volume. Specify one of the following values:

\n " + "smithy.api#documentation": "

The security style for the volume. If a volume's security style is not specified, \n it is automatically set to the root volume's security style. \n Specify one of the following values:

\n " } }, "SizeInMegabytes": { diff --git a/codegen/sdk-codegen/aws-models/voice-id.json b/codegen/sdk-codegen/aws-models/voice-id.json index 0101cd4411b..fcd2e47cfc4 100644 --- a/codegen/sdk-codegen/aws-models/voice-id.json +++ b/codegen/sdk-codegen/aws-models/voice-id.json @@ -9,7 +9,7 @@ } }, "traits": { - "smithy.api#documentation": "

You do not have sufficient permissions to perform this action. Check the error message and try \n again.

", + "smithy.api#documentation": "

You do not have sufficient permissions to perform this action. Check the error message\n and try again.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } @@ -86,54 +86,54 @@ "AuthenticationResultId": { "target": "com.amazonaws.voiceid#UniqueIdLarge", "traits": { - "smithy.api#documentation": "

The unique identifier for this authentication result. Because there can be multiple authentications\n for a given session, this field helps to identify if the returned result is from a previous streaming \n activity or a new result. Note that in absence of any new streaming activity, \n AcceptanceThreshold changes, or SpeakerId changes, Voice ID \n always returns cached Authentication Result for this API.

" + "smithy.api#documentation": "

The unique identifier for this authentication result. Because there can be multiple\n authentications for a given session, this field helps to identify if the returned result\n is from a previous streaming activity or a new result. Note that in absence of any new\n streaming activity, AcceptanceThreshold changes, or SpeakerId\n changes, Voice ID always returns cached Authentication Result for this API.

" } }, "AudioAggregationStartedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp indicating when audio aggregation started for this authentication result.

" + "smithy.api#documentation": "

A timestamp indicating when audio aggregation started for this authentication\n result.

" } }, "AudioAggregationEndedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp indicating when audio aggregation ended for this authentication result.

" + "smithy.api#documentation": "

A timestamp indicating when audio aggregation ended for this authentication\n result.

" } }, "CustomerSpeakerId": { "target": "com.amazonaws.voiceid#CustomerSpeakerId", "traits": { - "smithy.api#documentation": "

The client-provided identifier for the speaker whose authentication result is produced. Only present if a\n SpeakerId is provided for the session.

" + "smithy.api#documentation": "

The client-provided identifier for the speaker whose authentication result is\n produced. Only present if a SpeakerId is provided for the session.

" } }, "GeneratedSpeakerId": { "target": "com.amazonaws.voiceid#GeneratedSpeakerId", "traits": { - "smithy.api#documentation": "

The service-generated identifier for the speaker whose authentication result is produced.

" + "smithy.api#documentation": "

The service-generated identifier for the speaker whose authentication result is\n produced.

" } }, "Decision": { "target": "com.amazonaws.voiceid#AuthenticationDecision", "traits": { - "smithy.api#documentation": "

The authentication decision produced by Voice ID, processed against the current session state and streamed\n audio of the speaker.

" + "smithy.api#documentation": "

The authentication decision produced by Voice ID, processed against the current\n session state and streamed audio of the speaker.

" } }, "Score": { "target": "com.amazonaws.voiceid#Score", "traits": { - "smithy.api#documentation": "

The authentication score for the speaker whose authentication result is produced. This value is \n only present if the authentication decision is either ACCEPT or REJECT.

" + "smithy.api#documentation": "

The authentication score for the speaker whose authentication result is produced. This\n value is only present if the authentication decision is either ACCEPT or\n REJECT.

" } }, "Configuration": { "target": "com.amazonaws.voiceid#AuthenticationConfiguration", "traits": { - "smithy.api#documentation": "

The AuthenticationConfiguration used to generate this authentication result.

" + "smithy.api#documentation": "

The AuthenticationConfiguration used to generate this authentication\n result.

" } } }, "traits": { - "smithy.api#documentation": "

The authentication result produced by Voice ID, processed against the current session state and streamed\n audio of the speaker.

" + "smithy.api#documentation": "

The authentication result produced by Voice ID, processed against the current session\n state and streamed audio of the speaker.

" } }, "com.amazonaws.voiceid#ClientTokenString": { @@ -155,12 +155,12 @@ "ConflictType": { "target": "com.amazonaws.voiceid#ConflictType", "traits": { - "smithy.api#documentation": "

The type of conflict which caused a ConflictException. Possible types and the corresponding error messages\n are as follows:

\n " + "smithy.api#documentation": "

The type of conflict which caused a ConflictException. Possible types and the\n corresponding error messages are as follows:

\n " } } }, "traits": { - "smithy.api#documentation": "

The request failed due to a conflict. Check the ConflictType and error message for\n more details.

", + "smithy.api#documentation": "

The request failed due to a conflict. Check the ConflictType and error\n message for more details.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } @@ -236,11 +236,7 @@ } ], "traits": { - "smithy.api#documentation": "

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer \n audio, and voiceprints.\n

", - "smithy.api#http": { - "method": "POST", - "uri": "/domains" - }, + "smithy.api#documentation": "

Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters,\n customer audio, and voiceprints.

", "smithy.api#idempotent": {} } }, @@ -257,27 +253,35 @@ "Description": { "target": "com.amazonaws.voiceid#Description", "traits": { - "smithy.api#documentation": "

A brief description of this domain.

" + "smithy.api#documentation": "

A brief description of the domain.

" } }, "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by Voice ID for \n the server-side encryption of your data. Refer to \n Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.\n

", + "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by\n Voice ID for the server-side encryption of your data. Refer to \n Amazon Connect Voice ID encryption at rest for more details on how the KMS key is used.

", "smithy.api#required": {} } }, "ClientToken": { "target": "com.amazonaws.voiceid#ClientTokenString", "traits": { - "smithy.api#documentation": "

The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates \n this field.

", - "smithy.api#idempotencyToken": {} + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

The idempotency token for creating a new domain. If not provided, Amazon Web Services\n SDK populates this field.

", + "smithy.api#idempotencyToken": {}, + "smithy.api#suppress": [ + "UnstableTrait" + ] } }, "Tags": { "target": "com.amazonaws.voiceid#TagList", "traits": { - "smithy.api#documentation": "

A list of tags you want added to the domain.

" + "aws.cloudformation#cfnMutability": "full", + "smithy.api#documentation": "

A list of tags you want added to the domain.

", + "smithy.api#suppress": [ + "UnstableTrait" + ] } } } @@ -334,11 +338,7 @@ ], "traits": { "smithy.api#documentation": "

Deletes the specified domain from Voice ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/domains/{DomainId}", - "code": 204 - } + "smithy.api#idempotent": {} } }, "com.amazonaws.voiceid#DeleteDomainRequest": { @@ -348,7 +348,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain you want to delete.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -383,12 +382,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified fraudster from Voice ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/domains/{DomainId}/fraudsters/{FraudsterId}", - "code": 204 - } + "smithy.api#documentation": "

Deletes the specified fraudster from Voice ID.

" } }, "com.amazonaws.voiceid#DeleteFraudsterRequest": { @@ -398,7 +392,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the fraudster.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -406,7 +399,6 @@ "target": "com.amazonaws.voiceid#FraudsterId", "traits": { "smithy.api#documentation": "

The identifier of the fraudster you want to delete.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -441,12 +433,7 @@ } ], "traits": { - "smithy.api#documentation": "

Deletes the specified speaker from Voice ID.

", - "smithy.api#http": { - "method": "DELETE", - "uri": "/domains/{DomainId}/speakers/{SpeakerId}", - "code": 204 - } + "smithy.api#documentation": "

Deletes the specified speaker from Voice ID.

" } }, "com.amazonaws.voiceid#DeleteSpeakerRequest": { @@ -456,7 +443,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the speaker.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -464,7 +450,6 @@ "target": "com.amazonaws.voiceid#SpeakerId", "traits": { "smithy.api#documentation": "

The identifier of the speaker you want to delete.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -497,10 +482,7 @@ ], "traits": { "smithy.api#documentation": "

Describes the specified domain.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}" - } + "smithy.api#readonly": {} } }, "com.amazonaws.voiceid#DescribeDomainRequest": { @@ -510,7 +492,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain you are describing.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -522,7 +503,11 @@ "Domain": { "target": "com.amazonaws.voiceid#Domain", "traits": { - "smithy.api#documentation": "

Information about the specified domain.

" + "aws.cloudformation#cfnExcludeProperty": {}, + "smithy.api#documentation": "

Information about the specified domain.

", + "smithy.api#suppress": [ + "UnstableTrait" + ] } } } @@ -553,11 +538,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified fraudster.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/fraudsters/{FraudsterId}" - } + "smithy.api#documentation": "

Describes the specified fraudster.

" } }, "com.amazonaws.voiceid#DescribeFraudsterRegistrationJob": { @@ -586,11 +567,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified fraudster registration job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/fraudster-registration-jobs/{JobId}" - } + "smithy.api#documentation": "

Describes the specified fraudster registration job.

" } }, "com.amazonaws.voiceid#DescribeFraudsterRegistrationJobRequest": { @@ -600,7 +577,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier for the domain containing the fraudster registration job.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -608,7 +584,6 @@ "target": "com.amazonaws.voiceid#JobId", "traits": { "smithy.api#documentation": "

The identifier for the fraudster registration job you are describing.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -632,7 +607,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the fraudster.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -640,7 +614,6 @@ "target": "com.amazonaws.voiceid#FraudsterId", "traits": { "smithy.api#documentation": "

The identifier of the fraudster you are describing.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -683,11 +656,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified speaker.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/speakers/{SpeakerId}" - } + "smithy.api#documentation": "

Describes the specified speaker.

" } }, "com.amazonaws.voiceid#DescribeSpeakerEnrollmentJob": { @@ -716,11 +685,7 @@ } ], "traits": { - "smithy.api#documentation": "

Describes the specified speaker enrollment job.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/speaker-enrollment-jobs/{JobId}" - } + "smithy.api#documentation": "

Describes the specified speaker enrollment job.

" } }, "com.amazonaws.voiceid#DescribeSpeakerEnrollmentJobRequest": { @@ -730,7 +695,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the speaker enrollment job.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -738,7 +702,6 @@ "target": "com.amazonaws.voiceid#JobId", "traits": { "smithy.api#documentation": "

The identifier of the speaker enrollment job you are describing.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -762,7 +725,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain that contains the speaker.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -770,7 +732,6 @@ "target": "com.amazonaws.voiceid#SpeakerId", "traits": { "smithy.api#documentation": "

The identifier of the speaker you are describing.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -834,7 +795,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use\n to encrypt your data.

" + "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key\n identifier you want Voice ID to use to encrypt your data.

" } }, "CreatedAt": { @@ -852,7 +813,7 @@ "ServerSideEncryptionUpdateDetails": { "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails", "traits": { - "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain's data can only be accessed using the\n new KMS key.

" + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the\n server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is\n complete, the domain's data can only be accessed using the new KMS key.

" } } }, @@ -881,6 +842,37 @@ "smithy.api#sensitive": {} } }, + "com.amazonaws.voiceid#DomainResource": { + "type": "resource", + "identifiers": { + "DomainId": { + "target": "com.amazonaws.voiceid#DomainId" + } + }, + "create": { + "target": "com.amazonaws.voiceid#CreateDomain" + }, + "read": { + "target": "com.amazonaws.voiceid#DescribeDomain" + }, + "update": { + "target": "com.amazonaws.voiceid#UpdateDomain" + }, + "delete": { + "target": "com.amazonaws.voiceid#DeleteDomain" + }, + "list": { + "target": "com.amazonaws.voiceid#ListDomains" + }, + "traits": { + "aws.cloudformation#cfnResource": { + "name": "Domain" + }, + "smithy.api#suppress": [ + "UnstableTrait" + ] + } + }, "com.amazonaws.voiceid#DomainStatus": { "type": "string", "traits": { @@ -942,7 +934,7 @@ "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key identifier you want Voice ID to use\n to encrypt your data.

" + "smithy.api#documentation": "

The server-side encryption configuration containing the KMS key\n identifier you want Voice ID to use to encrypt your data.

" } }, "CreatedAt": { @@ -960,7 +952,7 @@ "ServerSideEncryptionUpdateDetails": { "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails", "traits": { - "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain’s data can only be accessed using the\n new KMS key.

" + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the\n server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is\n complete, the domain's data can only be accessed using the new KMS key.

" } } }, @@ -989,7 +981,7 @@ "ExistingEnrollmentAction": { "target": "com.amazonaws.voiceid#ExistingEnrollmentAction", "traits": { - "smithy.api#documentation": "

The action to take when the specified speaker is already enrolled in the specified domain. The default \n value is SKIP, which skips the enrollment for the existing speaker. Setting the value to\n OVERWRITE replaces the existing voice prints and enrollment audio stored for that speaker\n with new data generated from the latest audio.

" + "smithy.api#documentation": "

The action to take when the specified speaker is already enrolled in the specified\n domain. The default value is SKIP, which skips the enrollment for the\n existing speaker. Setting the value to OVERWRITE replaces the existing\n voice prints and enrollment audio stored for that speaker with new data generated from\n the latest audio.

" } }, "FraudDetectionConfig": { @@ -1009,18 +1001,18 @@ "FraudDetectionAction": { "target": "com.amazonaws.voiceid#FraudDetectionAction", "traits": { - "smithy.api#documentation": "

The action to take when the given speaker is flagged by the fraud detection system. The default value is\n FAIL, which fails the speaker enrollment. Changing this value to IGNORE \n results in the speaker being enrolled even if they are flagged by the fraud detection system.

" + "smithy.api#documentation": "

The action to take when the given speaker is flagged by the fraud detection system.\n The default value is FAIL, which fails the speaker enrollment. Changing\n this value to IGNORE results in the speaker being enrolled even if they are\n flagged by the fraud detection system.

" } }, "RiskThreshold": { "target": "com.amazonaws.voiceid#Score", "traits": { - "smithy.api#documentation": "

Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk\n score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.

" + "smithy.api#documentation": "

Threshold value for determining whether the speaker is a high risk to be fraudulent.\n If the detected risk score calculated by Voice ID is greater than or equal to the\n threshold, the speaker is considered a fraudster.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration defining the action to take when a speaker is flagged by the fraud detection system\n during a batch speaker enrollment job, and the risk threshold to use for identification.

" + "smithy.api#documentation": "

The configuration defining the action to take when a speaker is flagged by the fraud\n detection system during a batch speaker enrollment job, and the risk threshold to use\n for identification.

" } }, "com.amazonaws.voiceid#EvaluateSession": { @@ -1052,11 +1044,7 @@ } ], "traits": { - "smithy.api#documentation": "

Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice \n ID call.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/sessions/{SessionNameOrId}/evaluate" - } + "smithy.api#documentation": "

Evaluates a specified session based on audio data accumulated during a streaming\n Amazon Connect Voice ID call.

" } }, "com.amazonaws.voiceid#EvaluateSessionRequest": { @@ -1066,15 +1054,13 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain where the session started.

", - "smithy.api#httpQuery": "domainId", "smithy.api#required": {} } }, "SessionNameOrId": { "target": "com.amazonaws.voiceid#SessionNameOrId", "traits": { - "smithy.api#documentation": "

The session identifier, or name of the session, that you want to evaluate. In Voice ID\n integration, this is the Contact-Id.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The session identifier, or name of the session, that you want to evaluate. In\n Voice ID integration, this is the Contact-Id.

", "smithy.api#required": {} } } @@ -1104,7 +1090,7 @@ "StreamingStatus": { "target": "com.amazonaws.voiceid#StreamingStatus", "traits": { - "smithy.api#documentation": "

The current status of audio streaming for this session. This field is useful to infer next steps when\n the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH.\n In this situation, if the StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can\n mean that the client should call the API again later, after Voice ID has enough audio to produce a result.\n If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED,\n it means that the previously streamed session did not have enough speech to perform evaluation, and a new\n streaming session is needed to try again.

" + "smithy.api#documentation": "

The current status of audio streaming for this session. This field is useful to infer\n next steps when the Authentication or Fraud Detection results are empty or the decision\n is NOT_ENOUGH_SPEECH. In this situation, if the\n StreamingStatus is ONGOING/PENDING_CONFIGURATION, it can\n mean that the client should call the API again later, after Voice ID has enough audio\n to produce a result. If the decision remains NOT_ENOUGH_SPEECH even after\n StreamingStatus is ENDED, it means that the previously\n streamed session did not have enough speech to perform evaluation, and a new streaming\n session is needed to try again.

" } }, "AuthenticationResult": { @@ -1116,7 +1102,7 @@ "FraudDetectionResult": { "target": "com.amazonaws.voiceid#FraudDetectionResult", "traits": { - "smithy.api#documentation": "

Details resulting from the fraud detection process, such as fraud detection decision and risk score.

" + "smithy.api#documentation": "

Details resulting from the fraud detection process, such as fraud detection decision\n and risk score.

" } } } @@ -1177,13 +1163,13 @@ "RiskThreshold": { "target": "com.amazonaws.voiceid#Score", "traits": { - "smithy.api#documentation": "

Threshold value for determining whether the speaker is a fraudster. If the detected risk score \n calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.

", + "smithy.api#documentation": "

Threshold value for determining whether the speaker is a fraudster. If the detected\n risk score calculated by Voice ID is higher than the threshold, the speaker is\n considered a fraudster.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration used for performing fraud detection over a speaker during a session.

" + "smithy.api#documentation": "

The configuration used for performing fraud detection over a speaker during a\n session.

" } }, "com.amazonaws.voiceid#FraudDetectionDecision": { @@ -1212,6 +1198,10 @@ { "value": "KNOWN_FRAUDSTER", "name": "KNOWN_FRAUDSTER" + }, + { + "value": "VOICE_SPOOFING", + "name": "VOICE_SPOOFING" } ] } @@ -1234,48 +1224,48 @@ "FraudDetectionResultId": { "target": "com.amazonaws.voiceid#UniqueIdLarge", "traits": { - "smithy.api#documentation": "

The unique identifier for this fraud detection result. Given there can be multiple fraud detections \n for a given session, this field helps in identifying if the returned result is from previous streaming \n activity or a new result. Note that in the absence of any new streaming activity or risk threshold \n changes, Voice ID always returns cached Fraud Detection result for this API.

" + "smithy.api#documentation": "

The unique identifier for this fraud detection result. Given there can be multiple\n fraud detections for a given session, this field helps in identifying if the returned\n result is from previous streaming activity or a new result. Note that in the absence of\n any new streaming activity or risk threshold changes, Voice ID always returns cached\n Fraud Detection result for this API.

" } }, "AudioAggregationStartedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp indicating when audio aggregation started for this fraud detection result.

" + "smithy.api#documentation": "

A timestamp indicating when audio aggregation started for this fraud detection\n result.

" } }, "AudioAggregationEndedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

A timestamp indicating when audio aggregation ended for this fraud detection result.

" + "smithy.api#documentation": "

A timestamp indicating when audio aggregation ended for this fraud detection\n result.

" } }, "Configuration": { "target": "com.amazonaws.voiceid#FraudDetectionConfiguration", "traits": { - "smithy.api#documentation": "

The FraudDetectionConfiguration used to generate this fraud detection result.

" + "smithy.api#documentation": "

The FraudDetectionConfiguration used to generate this fraud detection\n result.

" } }, "Decision": { "target": "com.amazonaws.voiceid#FraudDetectionDecision", "traits": { - "smithy.api#documentation": "

The fraud detection decision produced by Voice ID, processed against the current session state and\n streamed audio of the speaker.

" + "smithy.api#documentation": "

The fraud detection decision produced by Voice ID, processed against the current\n session state and streamed audio of the speaker.

" } }, "Reasons": { "target": "com.amazonaws.voiceid#FraudDetectionReasons", "traits": { - "smithy.api#documentation": "

The reason speaker was flagged by the fraud detection system. This is only be populated if fraud\n detection Decision is HIGH_RISK, and only has one possible value:\n KNOWN_FRAUDSTER.

" + "smithy.api#documentation": "

The reason speaker was flagged by the fraud detection system. This is only be\n populated if fraud detection Decision is HIGH_RISK, and the following\n possible values: KNOWN_FRAUDSTER and VOICE_SPOOFING.

" } }, "RiskDetails": { "target": "com.amazonaws.voiceid#FraudRiskDetails", "traits": { - "smithy.api#documentation": "

Details about each risk analyzed for this speaker.

" + "smithy.api#documentation": "

Details about each risk analyzed for this speaker. Currently, this contains\n KnownFraudsterRisk and VoiceSpoofingRisk details.

" } } }, "traits": { - "smithy.api#documentation": "

The fraud detection result produced by Voice ID, processed against the current session state and streamed\n audio of the speaker.

" + "smithy.api#documentation": "

The fraud detection result produced by Voice ID, processed against the current\n session state and streamed audio of the speaker.

" } }, "com.amazonaws.voiceid#FraudRiskDetails": { @@ -1287,10 +1277,17 @@ "smithy.api#documentation": "

The details resulting from 'Known Fraudster Risk' analysis of the speaker.

", "smithy.api#required": {} } + }, + "VoiceSpoofingRisk": { + "target": "com.amazonaws.voiceid#VoiceSpoofingRisk", + "traits": { + "smithy.api#documentation": "

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

", + "smithy.api#required": {} + } } }, "traits": { - "smithy.api#documentation": "

Details regarding various fraud risk analyses performed against the current session state and streamed\n audio of the speaker.

" + "smithy.api#documentation": "

Details regarding various fraud risk analyses performed against the current session\n state and streamed audio of the speaker.

" } }, "com.amazonaws.voiceid#Fraudster": { @@ -1360,25 +1357,25 @@ "DataAccessRoleArn": { "target": "com.amazonaws.voiceid#IamRoleArn", "traits": { - "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets\n to read the input manifest file and write the job output file.

" + "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access\n customer's buckets to read the input manifest file and write the job output file.

" } }, "RegistrationConfig": { "target": "com.amazonaws.voiceid#RegistrationConfig", "traits": { - "smithy.api#documentation": "

The registration config containing details such as the action to take when a duplicate fraudster is \n detected, and the similarity threshold to use for detecting a duplicate fraudster.

" + "smithy.api#documentation": "

The registration config containing details such as the action to take when a duplicate\n fraudster is detected, and the similarity threshold to use for detecting a duplicate\n fraudster.

" } }, "InputDataConfig": { "target": "com.amazonaws.voiceid#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains the list\n of fraudster registration job requests.

" + "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains\n the list of fraudster registration job requests.

" } }, "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where you want Voice ID to write your job output \n file; you must also include a KMS key iD in order to encrypt the file.

" + "smithy.api#documentation": "

The output data config containing the S3 location where you want Voice ID to write\n your job output file; you must also include a KMS key ID in order to\n encrypt the file.

" } }, "CreatedAt": { @@ -1396,13 +1393,13 @@ "FailureDetails": { "target": "com.amazonaws.voiceid#FailureDetails", "traits": { - "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of individual registration\n job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of\n COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual \n registration requests that failed.

" + "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of\n individual registration job failures, the batch job as a whole doesn't fail; it is\n completed with a JobStatus of COMPLETED_WITH_ERRORS. You can\n use the job output file to identify the individual registration requests that\n failed.

" } }, "JobProgress": { "target": "com.amazonaws.voiceid#JobProgress", "traits": { - "smithy.api#documentation": "

Shows the completed percentage of registration requests listed in the input file.

" + "smithy.api#documentation": "

Shows the completed percentage of registration requests listed in the input\n file.

" } } }, @@ -1449,7 +1446,7 @@ "JobName": { "target": "com.amazonaws.voiceid#JobName", "traits": { - "smithy.api#documentation": "

The client-provied name for the fraudster registration job.

" + "smithy.api#documentation": "

The client-provided name for the fraudster registration job.

" } }, "JobId": { @@ -1485,13 +1482,13 @@ "FailureDetails": { "target": "com.amazonaws.voiceid#FailureDetails", "traits": { - "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of individual registration\n job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of\n COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual \n registration requests that failed.

" + "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of\n individual registration job failures, the batch job as a whole doesn't fail; it is\n completed with a JobStatus of COMPLETED_WITH_ERRORS. You can\n use the job output file to identify the individual registration requests that\n failed.

" } }, "JobProgress": { "target": "com.amazonaws.voiceid#JobProgress", "traits": { - "smithy.api#documentation": "

Shows the completed percentage of registration requests listed in the input file.

" + "smithy.api#documentation": "

Shows the completed percentage of registration requests listed in the input\n file.

" } } }, @@ -1535,7 +1532,7 @@ "S3Uri": { "target": "com.amazonaws.voiceid#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 location for the input manifest file that contains the list of individual enrollment or registration\n job requests.

", + "smithy.api#documentation": "

The S3 location for the input manifest file that contains the list of individual\n enrollment or registration job requests.

", "smithy.api#required": {} } } @@ -1590,7 +1587,7 @@ "PercentComplete": { "target": "com.amazonaws.voiceid#Score", "traits": { - "smithy.api#documentation": "

Shows the completed percentage of enrollment or registration requests listed in the input file.

" + "smithy.api#documentation": "

Shows the completed percentage of enrollment or registration requests listed in the\n input file.

" } } }, @@ -1620,12 +1617,12 @@ "GeneratedFraudsterId": { "target": "com.amazonaws.voiceid#GeneratedFraudsterId", "traits": { - "smithy.api#documentation": "

The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters\n registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is\n null.

" + "smithy.api#documentation": "

The identifier of the fraudster that is the closest match to the speaker. If there are\n no fraudsters registered in a given domain, or if there are no fraudsters with a\n non-zero RiskScore, this value is null.

" } } }, "traits": { - "smithy.api#documentation": "

Contains details produced as a result of performing known fraudster risk analysis on a speaker.

" + "smithy.api#documentation": "

Contains details produced as a result of performing known fraudster risk analysis on a\n speaker.

" } }, "com.amazonaws.voiceid#ListDomains": { @@ -1651,17 +1648,14 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the domains in the Amazon Web Services account.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains" - }, + "smithy.api#documentation": "

Lists all the domains in the Amazon Web Services account.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "items": "DomainSummaries", "pageSize": "MaxResults" - } + }, + "smithy.api#readonly": {} } }, "com.amazonaws.voiceid#ListDomainsRequest": { @@ -1670,15 +1664,13 @@ "MaxResults": { "target": "com.amazonaws.voiceid#MaxResultsForListDomainFe", "traits": { - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use NextToken to obtain\n further pages of results. The default is 100; the maximum allowed page size is also 100.\n

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The maximum number of domains to list per API call.

" } }, "NextToken": { "target": "com.amazonaws.voiceid#NextToken", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1695,7 +1687,7 @@ "NextToken": { "target": "com.amazonaws.voiceid#String", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1726,11 +1718,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the fraudster registration jobs in the domain with the given JobStatus.\n If JobStatus is not provided, this lists all fraudster registration jobs in the given\n domain.\n

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/fraudster-registration-jobs" - }, + "smithy.api#documentation": "

Lists all the fraudster registration jobs in the domain with the given\n JobStatus. If JobStatus is not provided, this lists all\n fraudster registration jobs in the given domain.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1746,29 +1734,25 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the fraudster registration Jobs.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.voiceid#FraudsterRegistrationJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of your fraudster registration job.

", - "smithy.api#httpQuery": "jobStatus" + "smithy.api#documentation": "

Provides the status of your fraudster registration job.

" } }, "MaxResults": { "target": "com.amazonaws.voiceid#MaxResultsForList", "traits": { - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use NextToken to obtain\n further pages of results. The default is 100; the maximum allowed page size is also 100.\n

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n NextToken to obtain further pages of results. The default is 100; the\n maximum allowed page size is also 100.

" } }, "NextToken": { "target": "com.amazonaws.voiceid#NextToken", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1785,7 +1769,7 @@ "NextToken": { "target": "com.amazonaws.voiceid#String", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1816,11 +1800,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all the speaker enrollment jobs in the domain with the specified JobStatus. If\n JobStatus is not provided, this lists all jobs with all possible speaker enrollment job\n statuses.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/speaker-enrollment-jobs" - }, + "smithy.api#documentation": "

Lists all the speaker enrollment jobs in the domain with the specified\n JobStatus. If JobStatus is not provided, this lists all\n jobs with all possible speaker enrollment job statuses.

", "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1836,29 +1816,25 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the speaker enrollment jobs.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "JobStatus": { "target": "com.amazonaws.voiceid#SpeakerEnrollmentJobStatus", "traits": { - "smithy.api#documentation": "

Provides the status of your speaker enrollment Job.

", - "smithy.api#httpQuery": "jobStatus" + "smithy.api#documentation": "

Provides the status of your speaker enrollment Job.

" } }, "MaxResults": { "target": "com.amazonaws.voiceid#MaxResultsForList", "traits": { - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use NextToken to obtain\n further pages of results. The default is 100; the maximum allowed page size is also 100.\n

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n NextToken to obtain further pages of results. The default is 100; the\n maximum allowed page size is also 100.

" } }, "NextToken": { "target": "com.amazonaws.voiceid#NextToken", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1875,7 +1851,7 @@ "NextToken": { "target": "com.amazonaws.voiceid#String", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1907,10 +1883,6 @@ ], "traits": { "smithy.api#documentation": "

Lists all speakers in a specified domain.

", - "smithy.api#http": { - "method": "GET", - "uri": "/domains/{DomainId}/speakers" - }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", @@ -1926,22 +1898,19 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MaxResults": { "target": "com.amazonaws.voiceid#MaxResultsForList", "traits": { - "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use NextToken to obtain\n further pages of results. The default is 100; the maximum allowed page size is also 100.\n

", - "smithy.api#httpQuery": "maxResults" + "smithy.api#documentation": "

The maximum number of results that are returned per call. You can use\n NextToken to obtain further pages of results. The default is 100; the\n maximum allowed page size is also 100.

" } }, "NextToken": { "target": "com.amazonaws.voiceid#NextToken", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

", - "smithy.api#httpQuery": "nextToken" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1958,7 +1927,7 @@ "NextToken": { "target": "com.amazonaws.voiceid#String", "traits": { - "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of NextToken\n is a unique pagination token for each page. Make the call again using the returned token to retrieve the\n next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.\n

" + "smithy.api#documentation": "

If NextToken is returned, there are more results available. The value of\n NextToken is a unique pagination token for each page. Make the call\n again using the returned token to retrieve the next page. Keep all other arguments\n unchanged. Each pagination token expires after 24 hours.

" } } } @@ -1989,11 +1958,7 @@ } ], "traits": { - "smithy.api#documentation": "

Lists all tags associated with a specified Voice ID resource.

", - "smithy.api#http": { - "uri": "/tags/{ResourceArn}", - "method": "GET" - } + "smithy.api#documentation": "

Lists all tags associated with a specified Voice ID resource.

" } }, "com.amazonaws.voiceid#ListTagsForResourceRequest": { @@ -2002,8 +1967,7 @@ "ResourceArn": { "target": "com.amazonaws.voiceid#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list\n the tags.

", "smithy.api#required": {} } } @@ -2071,6 +2035,9 @@ { "target": "com.amazonaws.voiceid#ResourceNotFoundException" }, + { + "target": "com.amazonaws.voiceid#ServiceQuotaExceededException" + }, { "target": "com.amazonaws.voiceid#ThrottlingException" }, @@ -2079,11 +2046,7 @@ } ], "traits": { - "smithy.api#documentation": "

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or not they\n already exist in Voice ID. If they don't yet exist, a new speaker is created in an opted out state.\n If they already exist, their existing status is overridden and they are opted out. Enrollment and\n evaluation authentication requests are rejected for opted out speakers, and opted out speakers have\n no voice embeddings stored in Voice ID.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/domains/{DomainId}/speakers/{SpeakerId}/optout" - } + "smithy.api#documentation": "

Opts out a speaker from Voice ID. A speaker can be opted out regardless of whether or\n not they already exist in Voice ID. If they don't yet exist, a new speaker is created\n in an opted out state. If they already exist, their existing status is overridden and\n they are opted out. Enrollment and evaluation authentication requests are rejected for\n opted out speakers, and opted out speakers have no voice embeddings stored in\n Voice ID.

" } }, "com.amazonaws.voiceid#OptOutSpeakerRequest": { @@ -2093,7 +2056,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain containing the speaker.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -2101,7 +2063,6 @@ "target": "com.amazonaws.voiceid#SpeakerId", "traits": { "smithy.api#documentation": "

The identifier of the speaker you want opted-out.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } } @@ -2124,14 +2085,14 @@ "S3Uri": { "target": "com.amazonaws.voiceid#S3Uri", "traits": { - "smithy.api#documentation": "

The S3 path of the folder where Voice ID writes the job output file. It has a \n *.out extension. For example, if the input file name is input-file.json and \n the output folder path is s3://output-bucket/output-folder, the full output file path is \n s3://output-bucket/output-folder/job-Id/input-file.json.out.

", + "smithy.api#documentation": "

The S3 path of the folder where Voice ID writes the job output file. It has a\n *.out extension. For example, if the input file name is\n input-file.json and the output folder path is\n s3://output-bucket/output-folder, the full output file path is\n s3://output-bucket/output-folder/job-Id/input-file.json.out.

", "smithy.api#required": {} } }, "KmsKeyId": { "target": "com.amazonaws.voiceid#KmsKeyId", "traits": { - "smithy.api#documentation": "

the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster\n registration job.

" + "smithy.api#documentation": "

The identifier of the KMS key you want Voice ID to use to encrypt the\n output file of a speaker enrollment job/fraudster registration job.\n

" } } }, @@ -2145,18 +2106,18 @@ "DuplicateRegistrationAction": { "target": "com.amazonaws.voiceid#DuplicateRegistrationAction", "traits": { - "smithy.api#documentation": "

The action to take when a fraudster is identified as a duplicate. The default action is \n SKIP, which skips registering the duplicate fraudster. Setting the value to\n REGISTER_AS_NEW always registers a new fraudster into the specified domain.

" + "smithy.api#documentation": "

The action to take when a fraudster is identified as a duplicate. The default action\n is SKIP, which skips registering the duplicate fraudster. Setting the value\n to REGISTER_AS_NEW always registers a new fraudster into the specified\n domain.

" } }, "FraudsterSimilarityThreshold": { "target": "com.amazonaws.voiceid#Score", "traits": { - "smithy.api#documentation": "

The minimum similarity score between the new and old fraudsters in order to consider the new \n fraudster a duplicate.

" + "smithy.api#documentation": "

The minimum similarity score between the new and old fraudsters in order to consider\n the new fraudster a duplicate.

" } } }, "traits": { - "smithy.api#documentation": "

The configuration defining the action to take when a duplicate fraudster is detected, and the \n similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.

" + "smithy.api#documentation": "

The configuration defining the action to take when a duplicate fraudster is detected,\n and the similarity threshold to use for detecting a duplicate fraudster during a batch\n fraudster registration job.

" } }, "com.amazonaws.voiceid#ResourceNotFoundException": { @@ -2168,12 +2129,12 @@ "ResourceType": { "target": "com.amazonaws.voiceid#ResourceType", "traits": { - "smithy.api#documentation": "

The type of resource which cannot not be found. Possible types are BATCH_JOB, COMPLIANCE_CONSENT,\n DOMAIN, FRAUDSTER, SESSION and SPEAKER.

" + "smithy.api#documentation": "

The type of resource which cannot not be found. Possible types are\n BATCH_JOB, COMPLIANCE_CONSENT, DOMAIN,\n FRAUDSTER, SESSION and SPEAKER.

" } } }, "traits": { - "smithy.api#documentation": "

The specified resource cannot be found. Check the ResourceType and error message for\n more details.

", + "smithy.api#documentation": "

The specified resource cannot be found. Check the ResourceType and error\n message for more details.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } @@ -2235,13 +2196,13 @@ "KmsKeyId": { "target": "com.amazonaws.voiceid#KmsKeyId", "traits": { - "smithy.api#documentation": "

The identifier of the KMS key you want Voice ID to use to encrypt your data.

", + "smithy.api#documentation": "

The identifier of the KMS key to use to encrypt data stored by\n Voice ID. Voice ID doesn't support asymmetric customer managed keys.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

The configuration containing information about the customer managed key used for encrypting\n customer data.

" + "smithy.api#documentation": "

The configuration containing information about the customer managed key used for\n encrypting customer data.

" } }, "com.amazonaws.voiceid#ServerSideEncryptionUpdateDetails": { @@ -2256,18 +2217,18 @@ "UpdateStatus": { "target": "com.amazonaws.voiceid#ServerSideEncryptionUpdateStatus", "traits": { - "smithy.api#documentation": "

Status of the server-side encryption update. During an update, if there is an issue with the domain's\n current or old KMS key ID, such as an inaccessible or disabled key, then the status\n is FAILED. In order to resolve this, the key needs to be made accessible, and then an UpdateDomain call\n with the existing server-side encryption configuration will re-attempt this update process.

" + "smithy.api#documentation": "

Status of the server-side encryption update. During an update, if there is an issue\n with the domain's current or old KMS key ID, such as an inaccessible or\n disabled key, then the status is FAILED. In order to resolve this, the key needs to be\n made accessible, and then an UpdateDomain call with the existing server-side encryption\n configuration will re-attempt this update process.

" } }, "Message": { "target": "com.amazonaws.voiceid#String", "traits": { - "smithy.api#documentation": "

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this message explains\n the cause of the failure.

" + "smithy.api#documentation": "

Message explaining the current UpdateStatus. When the UpdateStatus is FAILED, this\n message explains the cause of the failure.

" } } }, "traits": { - "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the server-side\n encryption configuration is changed, dependency on the old KMS key is removed through an\n asynchronous process. When this update is complete, the domain’s data can only be accessed using the\n new KMS key.

" + "smithy.api#documentation": "

Details about the most recent server-side encryption configuration update. When the\n server-side encryption configuration is changed, dependency on the old KMS key is removed through an asynchronous process. When this update is\n complete, the domain’s data can only be accessed using the new KMS key.

" } }, "com.amazonaws.voiceid#ServerSideEncryptionUpdateStatus": { @@ -2297,7 +2258,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request exceeded the service quota. Refer to Voice ID Service \n Quotas and try your request again.

", + "smithy.api#documentation": "

The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } @@ -2374,7 +2335,7 @@ "LastAccessedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

" + "smithy.api#documentation": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a\n successful authentication. This timestamp is accurate to one hour.

" } } }, @@ -2412,25 +2373,25 @@ "DataAccessRoleArn": { "target": "com.amazonaws.voiceid#IamRoleArn", "traits": { - "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets\n to read the input manifest file and write the job output file.

" + "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access\n customer's buckets to read the input manifest file and write the job output file.

" } }, "EnrollmentConfig": { "target": "com.amazonaws.voiceid#EnrollmentConfig", "traits": { - "smithy.api#documentation": "

The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the\n FraudDetectionConfig to use.

" + "smithy.api#documentation": "

The configuration that defines the action to take when the speaker is already enrolled\n in Voice ID, and the FraudDetectionConfig to use.

" } }, "InputDataConfig": { "target": "com.amazonaws.voiceid#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains the list\n of speaker enrollment job requests.

" + "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains\n the list of speaker enrollment job requests.

" } }, "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must \n also include a KMS key ID to encrypt the file.

" + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job\n output file; you must also include a KMS key ID to encrypt the\n file.

" } }, "CreatedAt": { @@ -2448,13 +2409,13 @@ "FailureDetails": { "target": "com.amazonaws.voiceid#FailureDetails", "traits": { - "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of individual registration\n job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of\n COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual \n registration requests that failed.

" + "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of\n individual registration job failures, the batch job as a whole doesn't fail; it is\n completed with a JobStatus of COMPLETED_WITH_ERRORS. You can\n use the job output file to identify the individual registration requests that\n failed.

" } }, "JobProgress": { "target": "com.amazonaws.voiceid#JobProgress", "traits": { - "smithy.api#documentation": "

Provides details on job progress. This field shows the completed percentage of registration \n requests listed in the input file.

" + "smithy.api#documentation": "

Provides details on job progress. This field shows the completed percentage of\n registration requests listed in the input file.

" } } }, @@ -2537,13 +2498,13 @@ "FailureDetails": { "target": "com.amazonaws.voiceid#FailureDetails", "traits": { - "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of individual registration\n job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus of\n COMPLETED_WITH_ERRORS. You can use the job output file to identify the individual \n registration requests that failed.

" + "smithy.api#documentation": "

Contains details that are populated when an entire batch job fails. In cases of\n individual registration job failures, the batch job as a whole doesn't fail; it is\n completed with a JobStatus of COMPLETED_WITH_ERRORS. You can\n use the job output file to identify the individual registration requests that\n failed.

" } }, "JobProgress": { "target": "com.amazonaws.voiceid#JobProgress", "traits": { - "smithy.api#documentation": "

Provides details regarding job progress. This field shows the completed percentage of enrollment \n requests listed in the input file.

" + "smithy.api#documentation": "

Provides details regarding job progress. This field shows the completed percentage of\n enrollment requests listed in the input file.

" } } }, @@ -2633,7 +2594,7 @@ "LastAccessedAt": { "target": "com.amazonaws.voiceid#Timestamp", "traits": { - "smithy.api#documentation": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a successful authentication. This timestamp is accurate to one hour.

" + "smithy.api#documentation": "

The timestamp when the speaker was last accessed for enrollment, re-enrollment or a\n successful authentication. This timestamp is accurate to one hour.

" } } }, @@ -2674,10 +2635,6 @@ ], "traits": { "smithy.api#documentation": "

Starts a new batch fraudster registration job using provided details.

", - "smithy.api#http": { - "method": "POST", - "uri": "/domains/{DomainId}/fraudster-registration-jobs" - }, "smithy.api#idempotent": {} } }, @@ -2687,7 +2644,7 @@ "ClientToken": { "target": "com.amazonaws.voiceid#ClientTokenString", "traits": { - "smithy.api#documentation": "

The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services \n SDK populates this field.

", + "smithy.api#documentation": "

The idempotency token for starting a new fraudster registration job. If not provided,\n Amazon Web Services SDK populates this field.

", "smithy.api#idempotencyToken": {} } }, @@ -2700,35 +2657,34 @@ "DomainId": { "target": "com.amazonaws.voiceid#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the domain containing the fraudster registration job and in which the fraudsters are\n registered.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The identifier of the domain containing the fraudster registration job and in which\n the fraudsters are registered.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.voiceid#IamRoleArn", "traits": { - "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets\n to read the input manifest file and write the Job output file. Refer to the\n Create and\n edit a fraudster watchlist documentation for the permissions needed in this role.

", + "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access\n customer's buckets to read the input manifest file and write the Job output file. Refer\n to the Create and edit a\n fraudster watchlist documentation for the permissions needed in this\n role.

", "smithy.api#required": {} } }, "RegistrationConfig": { "target": "com.amazonaws.voiceid#RegistrationConfig", "traits": { - "smithy.api#documentation": "

The registration config containing details such as the action to take when a duplicate fraudster is\n detected, and the similarity threshold to use for detecting a duplicate fraudster.

" + "smithy.api#documentation": "

The registration config containing details such as the action to take when a duplicate\n fraudster is detected, and the similarity threshold to use for detecting a duplicate\n fraudster.

" } }, "InputDataConfig": { "target": "com.amazonaws.voiceid#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains the list\n of fraudster registration requests.

", + "smithy.api#documentation": "

The input data config containing an S3 URI for the input manifest file that contains\n the list of fraudster registration requests.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS key ID to encrypt the file.

", + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job\n output file; you must also include a KMS key ID to encrypt the\n file.

", "smithy.api#required": {} } } @@ -2778,10 +2734,6 @@ ], "traits": { "smithy.api#documentation": "

Starts a new batch speaker enrollment job using specified details.

", - "smithy.api#http": { - "method": "POST", - "uri": "/domains/{DomainId}/speaker-enrollment-jobs" - }, "smithy.api#idempotent": {} } }, @@ -2791,7 +2743,7 @@ "ClientToken": { "target": "com.amazonaws.voiceid#ClientTokenString", "traits": { - "smithy.api#documentation": "

The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services \n SDK populates this field.

", + "smithy.api#documentation": "

The idempotency token for starting a new speaker enrollment Job. If not provided,\n Amazon Web Services SDK populates this field.

", "smithy.api#idempotencyToken": {} } }, @@ -2804,35 +2756,34 @@ "DomainId": { "target": "com.amazonaws.voiceid#DomainId", "traits": { - "smithy.api#documentation": "

The identifier of the domain that contains the speaker enrollment job and in which the speakers are\n enrolled.\n

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The identifier of the domain that contains the speaker enrollment job and in which the\n speakers are enrolled.

", "smithy.api#required": {} } }, "DataAccessRoleArn": { "target": "com.amazonaws.voiceid#IamRoleArn", "traits": { - "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access customer's buckets\n to read the input manifest file and write the job output file. Refer to Batch enrollment using audio data from prior\n calls documentation for the permissions needed in this role.

", + "smithy.api#documentation": "

The IAM role Amazon Resource Name (ARN) that grants Voice ID permissions to access\n customer's buckets to read the input manifest file and write the job output file. Refer\n to Batch enrollment using\n audio data from prior calls for the permissions needed in this role.

", "smithy.api#required": {} } }, "EnrollmentConfig": { "target": "com.amazonaws.voiceid#EnrollmentConfig", "traits": { - "smithy.api#documentation": "

The enrollment config that contains details such as the action to take when a speaker is already\n enrolled in Voice ID or when a speaker is identified as a fraudster.

" + "smithy.api#documentation": "

The enrollment config that contains details such as the action to take when a speaker\n is already enrolled in Voice ID or when a speaker is identified as a fraudster.

" } }, "InputDataConfig": { "target": "com.amazonaws.voiceid#InputDataConfig", "traits": { - "smithy.api#documentation": "

The input data config containing the S3 location for the input manifest file that contains the list of\n speaker enrollment requests.

", + "smithy.api#documentation": "

The input data config containing the S3 location for the input manifest file that\n contains the list of speaker enrollment requests.

", "smithy.api#required": {} } }, "OutputDataConfig": { "target": "com.amazonaws.voiceid#OutputDataConfig", "traits": { - "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job output file; you must\n also include a KMS key ID to encrypt the file.

", + "smithy.api#documentation": "

The output data config containing the S3 location where Voice ID writes the job\n output file; you must also include a KMS key ID to encrypt the\n file.

", "smithy.api#required": {} } } @@ -2882,20 +2833,20 @@ "Key": { "target": "com.amazonaws.voiceid#TagKey", "traits": { - "smithy.api#documentation": "

The first part of a key:value pair that forms a tag associated with a given resource. For example,\n in the tag ‘Department’:’Sales’, the key is 'Department'.\n

", + "smithy.api#documentation": "

The first part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag 'Department':'Sales', the key is 'Department'.

", "smithy.api#required": {} } }, "Value": { "target": "com.amazonaws.voiceid#TagValue", "traits": { - "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource. For example,\n in the tag ‘Department’:’Sales’, the value is 'Sales'.\n

", + "smithy.api#documentation": "

The second part of a key:value pair that forms a tag associated with a given resource.\n For example, in the tag 'Department':'Sales', the value is 'Sales'.

", "smithy.api#required": {} } } }, "traits": { - "smithy.api#documentation": "

A tag that can be assigned to a Voice ID resource.

" + "smithy.api#documentation": "

The tags used to organize, track, or control access for this resource. For example, { \"tags\": {\"key1\":\"value1\", \"key2\":\"value2\"} }.

" } }, "com.amazonaws.voiceid#TagKey": { @@ -2962,11 +2913,7 @@ } ], "traits": { - "smithy.api#documentation": "

Tags a Voice ID resource with the provided list of tags.

", - "smithy.api#http": { - "uri": "/tags/{ResourceArn}", - "method": "POST" - } + "smithy.api#documentation": "

Tags a Voice ID resource with the provided list of tags.

" } }, "com.amazonaws.voiceid#TagResourceRequest": { @@ -2976,7 +2923,6 @@ "target": "com.amazonaws.voiceid#AmazonResourceName", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -3012,7 +2958,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request was denied due to request throttling. Please slow down your request rate. Refer to\n \n Amazon Connect Voice ID Service API throttling quotas\n and try your request again.

", + "smithy.api#documentation": "

The request was denied due to request throttling. Please slow down your request rate.\n Refer to \n Amazon Connect Voice ID Service API throttling quotas and try your\n request again.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } @@ -3059,12 +3005,7 @@ } ], "traits": { - "smithy.api#documentation": "

Removes specified tags from a specified Amazon Connect Voice ID resource.

", - "smithy.api#http": { - "uri": "/tags/{ResourceArn}", - "method": "DELETE", - "code": 204 - } + "smithy.api#documentation": "

Removes specified tags from a specified Amazon Connect Voice ID resource.

" } }, "com.amazonaws.voiceid#UntagResourceRequest": { @@ -3073,8 +3014,7 @@ "ResourceArn": { "target": "com.amazonaws.voiceid#AmazonResourceName", "traits": { - "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.

", - "smithy.api#httpLabel": {}, + "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags\n from.

", "smithy.api#required": {} } }, @@ -3082,7 +3022,6 @@ "target": "com.amazonaws.voiceid#TagKeyList", "traits": { "smithy.api#documentation": "

The list of tag keys you want to remove from the specified resource.

", - "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } @@ -3121,11 +3060,7 @@ } ], "traits": { - "smithy.api#documentation": "

Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes.\n If an optional field, such as 'Description' is not provided, it is removed from the domain.

", - "smithy.api#http": { - "method": "PUT", - "uri": "/domains/{DomainId}" - } + "smithy.api#documentation": "

Updates the specified domain. This API has clobber behavior, and clears and replaces\n all attributes. If an optional field, such as 'Description' is not provided, it is\n removed from the domain.

" } }, "com.amazonaws.voiceid#UpdateDomainRequest": { @@ -3135,7 +3070,6 @@ "target": "com.amazonaws.voiceid#DomainId", "traits": { "smithy.api#documentation": "

The identifier of the domain to be updated.

", - "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, @@ -3149,13 +3083,13 @@ "Description": { "target": "com.amazonaws.voiceid#Description", "traits": { - "smithy.api#documentation": "

A brief description about this domain.

" + "smithy.api#documentation": "

A brief description of the domain.

" } }, "ServerSideEncryptionConfiguration": { "target": "com.amazonaws.voiceid#ServerSideEncryptionConfiguration", "traits": { - "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by Voice ID for the server-side\n encryption of your data. Note that all the existing data in the domain are still encrypted using the\n existing key, only the data added to domain after updating the key is encrypted using the new key.

", + "smithy.api#documentation": "

The configuration, containing the KMS key identifier, to be used by\n Voice ID for the server-side encryption of your data. Changing the domain's associated\n KMS key immediately triggers an asynchronous process to remove\n dependency on the old KMS key, such that the domain's data can only be\n accessed using the new KMS key. The domain's\n ServerSideEncryptionUpdateDetails contains the details for this\n process.

", "smithy.api#required": {} } } @@ -3180,7 +3114,7 @@ } }, "traits": { - "smithy.api#documentation": "

The request failed one or more validations; check the error message for more details.

", + "smithy.api#documentation": "

The request failed one or more validations; check the error message for more\n details.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } @@ -3199,26 +3133,17 @@ "name": "voiceid" }, "aws.protocols#awsJson1_0": {}, - "smithy.api#documentation": "

Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide\n describes the APIs used for this service.\n

", + "smithy.api#documentation": "

Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide\n describes the APIs used for this service.

", "smithy.api#title": "Amazon Voice ID" }, "version": "2021-09-27", "operations": [ - { - "target": "com.amazonaws.voiceid#CreateDomain" - }, - { - "target": "com.amazonaws.voiceid#DeleteDomain" - }, { "target": "com.amazonaws.voiceid#DeleteFraudster" }, { "target": "com.amazonaws.voiceid#DeleteSpeaker" }, - { - "target": "com.amazonaws.voiceid#DescribeDomain" - }, { "target": "com.amazonaws.voiceid#DescribeFraudster" }, @@ -3234,9 +3159,6 @@ { "target": "com.amazonaws.voiceid#EvaluateSession" }, - { - "target": "com.amazonaws.voiceid#ListDomains" - }, { "target": "com.amazonaws.voiceid#ListFraudsterRegistrationJobs" }, @@ -3263,11 +3185,28 @@ }, { "target": "com.amazonaws.voiceid#UntagResource" - }, + } + ], + "resources": [ { - "target": "com.amazonaws.voiceid#UpdateDomain" + "target": "com.amazonaws.voiceid#DomainResource" } ] + }, + "com.amazonaws.voiceid#VoiceSpoofingRisk": { + "type": "structure", + "members": { + "RiskScore": { + "target": "com.amazonaws.voiceid#Score", + "traits": { + "smithy.api#documentation": "

The score indicating the likelihood of speaker’s voice being spoofed.

", + "smithy.api#required": {} + } + } + }, + "traits": { + "smithy.api#documentation": "

The details resulting from 'Voice Spoofing Risk' analysis of the speaker.

" + } } } } \ No newline at end of file