diff --git a/CHANGELOG.md b/CHANGELOG.md index 66c71db132f..585d1ea2253 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,15 @@ +Release v1.40.50 (2021-09-27) +=== + +### Service Client Updates +* `service/appintegrations`: Updates service API and documentation +* `service/connect`: Updates service API and documentation +* `service/elasticloadbalancingv2`: Updates service API and documentation +* `service/pinpoint`: Updates service API and documentation + * Added support for journey with contact center activity +* `service/voice-id`: Updates service API, documentation, paginators, and examples +* `service/wisdom`: Updates service API, documentation, paginators, and examples + Release v1.40.49 (2021-09-24) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 04ee3513940..df471947254 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -1345,6 +1345,7 @@ var awsPartition = partition{ "ap-east-1": endpoint{}, "ap-northeast-1": endpoint{}, "ap-northeast-2": endpoint{}, + "ap-northeast-3": endpoint{}, "ap-south-1": endpoint{}, "ap-southeast-1": endpoint{}, "ap-southeast-2": endpoint{}, diff --git a/aws/version.go b/aws/version.go index a0374110838..be47f9b2401 100644 --- a/aws/version.go +++ b/aws/version.go @@ -5,4 +5,4 @@ package aws const SDKName = "aws-sdk-go" // SDKVersion is the version of this SDK -const SDKVersion = "1.40.49" +const SDKVersion = "1.40.50" diff --git a/models/apis/appintegrations/2020-07-29/api-2.json b/models/apis/appintegrations/2020-07-29/api-2.json index b0702d6a026..67017c21563 100644 --- a/models/apis/appintegrations/2020-07-29/api-2.json +++ b/models/apis/appintegrations/2020-07-29/api-2.json @@ -12,6 +12,23 @@ "uid":"appintegrations-2020-07-29" }, "operations":{ + "CreateDataIntegration":{ + "name":"CreateDataIntegration", + "http":{ + "method":"POST", + "requestUri":"/dataIntegrations" + }, + "input":{"shape":"CreateDataIntegrationRequest"}, + "output":{"shape":"CreateDataIntegrationResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ResourceQuotaExceededException"}, + {"shape":"DuplicateResourceException"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, "CreateEventIntegration":{ "name":"CreateEventIntegration", "http":{ @@ -29,6 +46,22 @@ {"shape":"AccessDeniedException"} ] }, + "DeleteDataIntegration":{ + "name":"DeleteDataIntegration", + "http":{ + "method":"DELETE", + "requestUri":"/dataIntegrations/{Identifier}" + }, + "input":{"shape":"DeleteDataIntegrationRequest"}, + "output":{"shape":"DeleteDataIntegrationResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, "DeleteEventIntegration":{ "name":"DeleteEventIntegration", "http":{ @@ -45,6 +78,22 @@ {"shape":"AccessDeniedException"} ] }, + "GetDataIntegration":{ + "name":"GetDataIntegration", + "http":{ + "method":"GET", + "requestUri":"/dataIntegrations/{Identifier}" + }, + "input":{"shape":"GetDataIntegrationRequest"}, + "output":{"shape":"GetDataIntegrationResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, "GetEventIntegration":{ "name":"GetEventIntegration", "http":{ @@ -61,6 +110,37 @@ {"shape":"AccessDeniedException"} ] }, + "ListDataIntegrationAssociations":{ + "name":"ListDataIntegrationAssociations", + "http":{ + "method":"GET", + "requestUri":"/dataIntegrations/{Identifier}/associations" + }, + "input":{"shape":"ListDataIntegrationAssociationsRequest"}, + "output":{"shape":"ListDataIntegrationAssociationsResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListDataIntegrations":{ + "name":"ListDataIntegrations", + "http":{ + "method":"GET", + "requestUri":"/dataIntegrations" + }, + "input":{"shape":"ListDataIntegrationsRequest"}, + "output":{"shape":"ListDataIntegrationsResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ThrottlingException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, "ListEventIntegrationAssociations":{ "name":"ListEventIntegrationAssociations", "http":{ @@ -137,6 +217,22 @@ {"shape":"ThrottlingException"} ] }, + "UpdateDataIntegration":{ + "name":"UpdateDataIntegration", + "http":{ + "method":"PATCH", + "requestUri":"/dataIntegrations/{Identifier}" + }, + "input":{"shape":"UpdateDataIntegrationRequest"}, + "output":{"shape":"UpdateDataIntegrationResponse"}, + "errors":[ + {"shape":"InternalServiceError"}, + {"shape":"ThrottlingException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"InvalidRequestException"}, + {"shape":"AccessDeniedException"} + ] + }, "UpdateEventIntegration":{ "name":"UpdateEventIntegration", "http":{ @@ -180,6 +276,36 @@ "min":1, "pattern":".*" }, + "CreateDataIntegrationRequest":{ + "type":"structure", + "required":["Name"], + "members":{ + "Name":{"shape":"Name"}, + "Description":{"shape":"Description"}, + "KmsKey":{"shape":"NonBlankString"}, + "SourceURI":{"shape":"NonBlankString"}, + "ScheduleConfig":{"shape":"ScheduleConfiguration"}, + "Tags":{"shape":"TagMap"}, + "ClientToken":{ + "shape":"IdempotencyToken", + "idempotencyToken":true + } + } + }, + "CreateDataIntegrationResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "Id":{"shape":"UUID"}, + "Name":{"shape":"Name"}, + "Description":{"shape":"Description"}, + "KmsKey":{"shape":"NonBlankString"}, + "SourceURI":{"shape":"NonBlankString"}, + "ScheduleConfiguration":{"shape":"ScheduleConfiguration"}, + "Tags":{"shape":"TagMap"}, + "ClientToken":{"shape":"IdempotencyToken"} + } + }, "CreateEventIntegrationRequest":{ "type":"structure", "required":[ @@ -205,6 +331,50 @@ "EventIntegrationArn":{"shape":"Arn"} } }, + "DataIntegrationAssociationSummary":{ + "type":"structure", + "members":{ + "DataIntegrationAssociationArn":{"shape":"Arn"}, + "DataIntegrationArn":{"shape":"Arn"}, + "ClientId":{"shape":"ClientId"} + } + }, + "DataIntegrationAssociationsList":{ + "type":"list", + "member":{"shape":"DataIntegrationAssociationSummary"}, + "max":50, + "min":1 + }, + "DataIntegrationSummary":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "Name":{"shape":"Name"}, + "SourceURI":{"shape":"NonBlankString"} + } + }, + "DataIntegrationsList":{ + "type":"list", + "member":{"shape":"DataIntegrationSummary"}, + "max":50, + "min":1 + }, + "DeleteDataIntegrationRequest":{ + "type":"structure", + "required":["DataIntegrationIdentifier"], + "members":{ + "DataIntegrationIdentifier":{ + "shape":"Identifier", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "DeleteDataIntegrationResponse":{ + "type":"structure", + "members":{ + } + }, "DeleteEventIntegrationRequest":{ "type":"structure", "required":["Name"], @@ -288,6 +458,30 @@ "max":50, "min":1 }, + "GetDataIntegrationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"Identifier", + "location":"uri", + "locationName":"Identifier" + } + } + }, + "GetDataIntegrationResponse":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "Id":{"shape":"UUID"}, + "Name":{"shape":"Name"}, + "Description":{"shape":"Description"}, + "KmsKey":{"shape":"NonBlankString"}, + "SourceURI":{"shape":"NonBlankString"}, + "ScheduleConfiguration":{"shape":"ScheduleConfiguration"}, + "Tags":{"shape":"TagMap"} + } + }, "GetEventIntegrationRequest":{ "type":"structure", "required":["Name"], @@ -316,6 +510,12 @@ "min":1, "pattern":".*" }, + "Identifier":{ + "type":"string", + "max":255, + "min":1, + "pattern":".*\\S.*" + }, "InternalServiceError":{ "type":"structure", "members":{ @@ -333,6 +533,56 @@ "error":{"httpStatusCode":400}, "exception":true }, + "ListDataIntegrationAssociationsRequest":{ + "type":"structure", + "required":["DataIntegrationIdentifier"], + "members":{ + "DataIntegrationIdentifier":{ + "shape":"Identifier", + "location":"uri", + "locationName":"Identifier" + }, + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDataIntegrationAssociationsResponse":{ + "type":"structure", + "members":{ + "DataIntegrationAssociations":{"shape":"DataIntegrationAssociationsList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDataIntegrationsRequest":{ + "type":"structure", + "members":{ + "NextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "MaxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + } + } + }, + "ListDataIntegrationsResponse":{ + "type":"structure", + "members":{ + "DataIntegrations":{"shape":"DataIntegrationsList"}, + "NextToken":{"shape":"NextToken"} + } + }, "ListEventIntegrationAssociationsRequest":{ "type":"structure", "required":["EventIntegrationName"], @@ -424,6 +674,12 @@ "min":1, "pattern":".*\\S.*" }, + "Object":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\/\\._\\-]+$" + }, "ResourceNotFoundException":{ "type":"structure", "members":{ @@ -440,6 +696,20 @@ "error":{"httpStatusCode":429}, "exception":true }, + "Schedule":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\/\\._\\-]+$" + }, + "ScheduleConfiguration":{ + "type":"structure", + "members":{ + "FirstExecutionFrom":{"shape":"NonBlankString"}, + "Object":{"shape":"Object"}, + "ScheduleExpression":{"shape":"Schedule"} + } + }, "Source":{ "type":"string", "max":256, @@ -525,6 +795,24 @@ "members":{ } }, + "UpdateDataIntegrationRequest":{ + "type":"structure", + "required":["Identifier"], + "members":{ + "Identifier":{ + "shape":"Identifier", + "location":"uri", + "locationName":"Identifier" + }, + "Name":{"shape":"Name"}, + "Description":{"shape":"Description"} + } + }, + "UpdateDataIntegrationResponse":{ + "type":"structure", + "members":{ + } + }, "UpdateEventIntegrationRequest":{ "type":"structure", "required":["Name"], diff --git a/models/apis/appintegrations/2020-07-29/docs-2.json b/models/apis/appintegrations/2020-07-29/docs-2.json index 9e166d215bc..719876b0a6b 100644 --- a/models/apis/appintegrations/2020-07-29/docs-2.json +++ b/models/apis/appintegrations/2020-07-29/docs-2.json @@ -1,15 +1,21 @@ { "version": "2.0", - "service": "
The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations in the Amazon Connect Administrator Guide.
", + "service": "The Amazon AppIntegrations service enables you to configure and reuse connections to external applications.
For information about how you can use external applications with Amazon Connect, see Set up pre-built integrations and Deliver information to agents using Amazon Connect Wisdom in the Amazon Connect Administrator Guide.
", "operations": { + "CreateDataIntegration": "Creates and persists a DataIntegration resource.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration
API.
Creates an EventIntegration, given a specified name, description, and a reference to an Amazon EventBridge bus in your account and a partner event source that pushes events to that bus. No objects are created in the your account, only metadata that is persisted on the EventIntegration control plane.
", + "DeleteDataIntegration": "Deletes the DataIntegration. Only DataIntegrations that don't have any DataIntegrationAssociations can be deleted. Deleting a DataIntegration also deletes the underlying Amazon AppFlow flow and service linked role.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Deletes the specified existing event integration. If the event integration is associated with clients, the request is rejected.
", - "GetEventIntegration": "Return information about the event integration.
", + "GetDataIntegration": "Returns information about the DataIntegration.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Returns information about the event integration.
", + "ListDataIntegrationAssociations": "Returns a paginated list of DataIntegration associations in the account.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Returns a paginated list of DataIntegrations in the account.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Returns a paginated list of event integration associations in the account.
", "ListEventIntegrations": "Returns a paginated list of event integrations in the account.
", "ListTagsForResource": "Lists the tags for the specified resource.
", "TagResource": "Adds the specified tags to the specified resource.
", "UntagResource": "Removes the specified tags from the specified resource.
", + "UpdateDataIntegration": "Updates the description of a DataIntegration.
You cannot create a DataIntegration association for a DataIntegration that has been previously associated. Use a different DataIntegration, or recreate the DataIntegration using the CreateDataIntegration API.
Updates the description of an event integration.
" }, "shapes": { @@ -21,9 +27,14 @@ "Arn": { "base": null, "refs": { + "CreateDataIntegrationResponse$Arn": "The Amazon Resource Name (ARN)
", "CreateEventIntegrationResponse$EventIntegrationArn": "The Amazon Resource Name (ARN) of the event integration.
", + "DataIntegrationAssociationSummary$DataIntegrationAssociationArn": "The Amazon Resource Name (ARN) of the DataIntegration association.
", + "DataIntegrationAssociationSummary$DataIntegrationArn": "The Amazon Resource Name (ARN)of the DataIntegration.
", + "DataIntegrationSummary$Arn": "The Amazon Resource Name (ARN) of the DataIntegration.
", "EventIntegration$EventIntegrationArn": "The Amazon Resource Name (ARN) of the event integration.
", "EventIntegrationAssociation$EventIntegrationAssociationArn": "The Amazon Resource Name (ARN) for the event integration association.
", + "GetDataIntegrationResponse$Arn": "The Amazon Resource Name (ARN) for the DataIntegration.
", "GetEventIntegrationResponse$EventIntegrationArn": "The Amazon Resource Name (ARN) for the event integration.
", "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", @@ -39,9 +50,20 @@ "ClientId": { "base": null, "refs": { + "DataIntegrationAssociationSummary$ClientId": "The identifier for teh client that is associated with the DataIntegration association.
", "EventIntegrationAssociation$ClientId": "The identifier for the client that is associated with the event integration.
" } }, + "CreateDataIntegrationRequest": { + "base": null, + "refs": { + } + }, + "CreateDataIntegrationResponse": { + "base": null, + "refs": { + } + }, "CreateEventIntegrationRequest": { "base": null, "refs": { @@ -52,6 +74,40 @@ "refs": { } }, + "DataIntegrationAssociationSummary": { + "base": "Summary information about the DataIntegration association.
", + "refs": { + "DataIntegrationAssociationsList$member": null + } + }, + "DataIntegrationAssociationsList": { + "base": null, + "refs": { + "ListDataIntegrationAssociationsResponse$DataIntegrationAssociations": "The Amazon Resource Name (ARN) and unique ID of the DataIntegration association.
" + } + }, + "DataIntegrationSummary": { + "base": "Summary information about the DataIntegration.
", + "refs": { + "DataIntegrationsList$member": null + } + }, + "DataIntegrationsList": { + "base": null, + "refs": { + "ListDataIntegrationsResponse$DataIntegrations": "The DataIntegrations associated with this account.
" + } + }, + "DeleteDataIntegrationRequest": { + "base": null, + "refs": { + } + }, + "DeleteDataIntegrationResponse": { + "base": null, + "refs": { + } + }, "DeleteEventIntegrationRequest": { "base": null, "refs": { @@ -65,9 +121,13 @@ "Description": { "base": null, "refs": { + "CreateDataIntegrationRequest$Description": "A description of the DataIntegration.
", + "CreateDataIntegrationResponse$Description": "A description of the DataIntegration.
", "CreateEventIntegrationRequest$Description": "The description of the event integration.
", "EventIntegration$Description": "The event integration description.
", + "GetDataIntegrationResponse$Description": "The KMS key for the DataIntegration.
", "GetEventIntegrationResponse$Description": "The description of the event integration.
", + "UpdateDataIntegrationRequest$Description": "A description of the DataIntegration.
", "UpdateEventIntegrationRequest$Description": "The description of the event inegration.
" } }, @@ -122,6 +182,16 @@ "ListEventIntegrationsResponse$EventIntegrations": "The event integrations.
" } }, + "GetDataIntegrationRequest": { + "base": null, + "refs": { + } + }, + "GetDataIntegrationResponse": { + "base": null, + "refs": { + } + }, "GetEventIntegrationRequest": { "base": null, "refs": { @@ -135,16 +205,47 @@ "IdempotencyToken": { "base": null, "refs": { + "CreateDataIntegrationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateDataIntegrationResponse$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "CreateEventIntegrationRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" } }, + "Identifier": { + "base": null, + "refs": { + "DeleteDataIntegrationRequest$DataIntegrationIdentifier": "A unique identifier for the DataIntegration.
", + "GetDataIntegrationRequest$Identifier": "A unique identifier.
", + "ListDataIntegrationAssociationsRequest$DataIntegrationIdentifier": "A unique identifier for the DataIntegration.
", + "UpdateDataIntegrationRequest$Identifier": "A unique identifier for the DataIntegration.
" + } + }, "InternalServiceError": { "base": "Request processing failed due to an error or failure with the service.
", "refs": { } }, "InvalidRequestException": { - "base": "The request is not valid.
", + "base": "The request is not valid.
", + "refs": { + } + }, + "ListDataIntegrationAssociationsRequest": { + "base": null, + "refs": { + } + }, + "ListDataIntegrationAssociationsResponse": { + "base": null, + "refs": { + } + }, + "ListDataIntegrationsRequest": { + "base": null, + "refs": { + } + }, + "ListDataIntegrationsResponse": { + "base": null, "refs": { } }, @@ -181,6 +282,8 @@ "MaxResults": { "base": null, "refs": { + "ListDataIntegrationAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", + "ListDataIntegrationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListEventIntegrationAssociationsRequest$MaxResults": "The maximum number of results to return per page.
", "ListEventIntegrationsRequest$MaxResults": "The maximum number of results to return per page.
" } @@ -200,19 +303,28 @@ "Name": { "base": null, "refs": { + "CreateDataIntegrationRequest$Name": "The name of the DataIntegration.
", + "CreateDataIntegrationResponse$Name": "The name of the DataIntegration.
", "CreateEventIntegrationRequest$Name": "The name of the event integration.
", + "DataIntegrationSummary$Name": "The name of the DataIntegration.
", "DeleteEventIntegrationRequest$Name": "The name of the event integration.
", "EventIntegration$Name": "The name of the event integration.
", "EventIntegrationAssociation$EventIntegrationName": "The name of the event integration.
", + "GetDataIntegrationResponse$Name": "The name of the DataIntegration.
", "GetEventIntegrationRequest$Name": "The name of the event integration.
", "GetEventIntegrationResponse$Name": "The name of the event integration.
", "ListEventIntegrationAssociationsRequest$EventIntegrationName": "The name of the event integration.
", + "UpdateDataIntegrationRequest$Name": "The name of the DataIntegration.
", "UpdateEventIntegrationRequest$Name": "The name of the event integration.
" } }, "NextToken": { "base": null, "refs": { + "ListDataIntegrationAssociationsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListDataIntegrationAssociationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", + "ListDataIntegrationsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListDataIntegrationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListEventIntegrationAssociationsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", "ListEventIntegrationAssociationsResponse$NextToken": "If there are additional results, this is the token for the next set of results.
", "ListEventIntegrationsRequest$NextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", @@ -223,7 +335,21 @@ "base": null, "refs": { "ClientAssociationMetadata$key": null, - "ClientAssociationMetadata$value": null + "ClientAssociationMetadata$value": null, + "CreateDataIntegrationRequest$KmsKey": "The KMS key for the DataIntegration.
", + "CreateDataIntegrationRequest$SourceURI": "The URI of the data source.
", + "CreateDataIntegrationResponse$KmsKey": "The KMS key for the DataIntegration.
", + "CreateDataIntegrationResponse$SourceURI": "The URI of the data source.
", + "DataIntegrationSummary$SourceURI": "The URI of the data source.
", + "GetDataIntegrationResponse$KmsKey": "The KMS key for the DataIntegration.
", + "GetDataIntegrationResponse$SourceURI": "The URI of the data source.
", + "ScheduleConfiguration$FirstExecutionFrom": "The start date for objects to import in the first flow run.
" + } + }, + "Object": { + "base": null, + "refs": { + "ScheduleConfiguration$Object": "The name of the object to pull from the data source.
" } }, "ResourceNotFoundException": { @@ -236,6 +362,20 @@ "refs": { } }, + "Schedule": { + "base": null, + "refs": { + "ScheduleConfiguration$ScheduleExpression": "How often the data should be pulled from data source.
" + } + }, + "ScheduleConfiguration": { + "base": "The name of the data and how often it should be pulled from the source.
", + "refs": { + "CreateDataIntegrationRequest$ScheduleConfig": "The name of the data and how often it should be pulled from the source.
", + "CreateDataIntegrationResponse$ScheduleConfiguration": "The name of the data and how often it should be pulled from the source.
", + "GetDataIntegrationResponse$ScheduleConfiguration": "The name of the data and how often it should be pulled from the source.
" + } + }, "Source": { "base": null, "refs": { @@ -258,8 +398,11 @@ "TagMap": { "base": null, "refs": { + "CreateDataIntegrationRequest$Tags": "One or more tags.
", + "CreateDataIntegrationResponse$Tags": "One or more tags.
", "CreateEventIntegrationRequest$Tags": "One or more tags.
", "EventIntegration$Tags": "The tags.
", + "GetDataIntegrationResponse$Tags": "One or more tags.
", "GetEventIntegrationResponse$Tags": "One or more tags.
", "ListTagsForResourceResponse$tags": "Information about the tags.
", "TagResourceRequest$tags": "One or more tags.
" @@ -289,7 +432,9 @@ "UUID": { "base": null, "refs": { - "EventIntegrationAssociation$EventIntegrationAssociationId": "The identifier for the event integration association.
" + "CreateDataIntegrationResponse$Id": "A unique identifier.
", + "EventIntegrationAssociation$EventIntegrationAssociationId": "The identifier for the event integration association.
", + "GetDataIntegrationResponse$Id": "A unique identifier.
" } }, "UntagResourceRequest": { @@ -302,6 +447,16 @@ "refs": { } }, + "UpdateDataIntegrationRequest": { + "base": null, + "refs": { + } + }, + "UpdateDataIntegrationResponse": { + "base": null, + "refs": { + } + }, "UpdateEventIntegrationRequest": { "base": null, "refs": { diff --git a/models/apis/connect/2017-08-08/api-2.json b/models/apis/connect/2017-08-08/api-2.json index 5699aeba13c..249446e40dd 100644 --- a/models/apis/connect/2017-08-08/api-2.json +++ b/models/apis/connect/2017-08-08/api-2.json @@ -1820,6 +1820,13 @@ "max":100, "min":1 }, + "AnswerMachineDetectionConfig":{ + "type":"structure", + "members":{ + "EnableAnswerMachineDetection":{"shape":"Boolean"}, + "AwaitAnswerMachinePrompt":{"shape":"Boolean"} + } + }, "AssociateApprovedOriginRequest":{ "type":"structure", "required":[ @@ -2006,6 +2013,11 @@ "max":128, "min":1 }, + "CampaignId":{ + "type":"string", + "max":100, + "min":1 + }, "Channel":{ "type":"string", "enum":[ @@ -2252,10 +2264,7 @@ "required":[ "InstanceId", "IntegrationType", - "IntegrationArn", - "SourceApplicationUrl", - "SourceApplicationName", - "SourceType" + "IntegrationArn" ], "members":{ "InstanceId":{ @@ -3660,7 +3669,13 @@ }, "IntegrationType":{ "type":"string", - "enum":["EVENT"] + "enum":[ + "EVENT", + "VOICE_ID", + "PINPOINT_APP", + "WISDOM_ASSISTANT", + "WISDOM_KNOWLEDGE_BASE" + ] }, "InternalServiceException":{ "type":"structure", @@ -4032,6 +4047,11 @@ "location":"uri", "locationName":"InstanceId" }, + "IntegrationType":{ + "shape":"IntegrationType", + "location":"querystring", + "locationName":"integrationType" + }, "NextToken":{ "shape":"NextToken", "location":"querystring", @@ -5433,7 +5453,10 @@ }, "SourcePhoneNumber":{"shape":"PhoneNumber"}, "QueueId":{"shape":"QueueId"}, - "Attributes":{"shape":"Attributes"} + "Attributes":{"shape":"Attributes"}, + "AnswerMachineDetectionConfig":{"shape":"AnswerMachineDetectionConfig"}, + "CampaignId":{"shape":"CampaignId"}, + "TrafficType":{"shape":"TrafficType"} } }, "StartOutboundVoiceContactResponse":{ @@ -5598,6 +5621,13 @@ }, "TimeZone":{"type":"string"}, "Timestamp":{"type":"timestamp"}, + "TrafficType":{ + "type":"string", + "enum":[ + "GENERAL", + "CAMPAIGN" + ] + }, "URI":{ "type":"string", "max":2000, @@ -6195,7 +6225,10 @@ }, "UseCaseType":{ "type":"string", - "enum":["RULES_EVALUATION"] + "enum":[ + "RULES_EVALUATION", + "CONNECT_CAMPAIGNS" + ] }, "User":{ "type":"structure", diff --git a/models/apis/connect/2017-08-08/docs-2.json b/models/apis/connect/2017-08-08/docs-2.json index e7979446bf9..0b5332d6887 100644 --- a/models/apis/connect/2017-08-08/docs-2.json +++ b/models/apis/connect/2017-08-08/docs-2.json @@ -14,18 +14,18 @@ "CreateContactFlow": "Creates a contact flow for the specified Amazon Connect instance.
You can also create and update contact flows using the Amazon Connect Flow language.
", "CreateHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Creates hours of operation.
", "CreateInstance": "This API is in preview release for Amazon Connect and is subject to change.
Initiates an Amazon Connect instance with all the supported channels enabled. It does not attach any storage, such as Amazon Simple Storage Service (Amazon S3) or Amazon Kinesis. It also does not allow for any configurations on features, such as Contact Lens for Amazon Connect.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", - "CreateIntegrationAssociation": "Create an AppIntegration association with an Amazon Connect instance.
", + "CreateIntegrationAssociation": "Creates an AWS resource association with an Amazon Connect instance.
", "CreateQueue": "This API is in preview release for Amazon Connect and is subject to change.
Creates a new queue for the specified Amazon Connect instance.
", "CreateQuickConnect": "Creates a quick connect for the specified Amazon Connect instance.
", "CreateRoutingProfile": "Creates a new routing profile.
", - "CreateUseCase": "Creates a use case for an AppIntegration association.
", + "CreateUseCase": "Creates a use case for an integration association.
", "CreateUser": "Creates a user account for the specified Amazon Connect instance.
For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.
", "CreateUserHierarchyGroup": "Creates a new user hierarchy group.
", "DeleteHoursOfOperation": "This API is in preview release for Amazon Connect and is subject to change.
Deletes an hours of operation.
", "DeleteInstance": "This API is in preview release for Amazon Connect and is subject to change.
Deletes the Amazon Connect instance.
Amazon Connect enforces a limit on the total number of instances that you can create or delete in 30 days. If you exceed this limit, you will get an error message indicating there has been an excessive number of attempts at creating or deleting instances. You must wait 30 days before you can restart creating and deleting instances in your account.
", - "DeleteIntegrationAssociation": "Deletes an AppIntegration association from an Amazon Connect instance. The association must not have any use cases associated with it.
", + "DeleteIntegrationAssociation": "Deletes an AWS resource association from an Amazon Connect instance. The association must not have any use cases associated with it.
", "DeleteQuickConnect": "Deletes a quick connect.
", - "DeleteUseCase": "Deletes a use case from an AppIntegration association.
", + "DeleteUseCase": "Deletes a use case from an integration association.
", "DeleteUser": "Deletes a user account from the specified Amazon Connect instance.
For information about what happens to a user's data when their account is deleted, see Delete Users from Your Amazon Connect Instance in the Amazon Connect Administrator Guide.
", "DeleteUserHierarchyGroup": "Deletes an existing user hierarchy group. It must not be associated with any agents or have any active child groups.
", "DescribeAgentStatus": "This API is in preview release for Amazon Connect and is subject to change.
Describes an agent status.
", @@ -60,7 +60,7 @@ "ListInstanceAttributes": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all attribute types for the given instance.
", "ListInstanceStorageConfigs": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of storage configs for the identified instance and resource type.
", "ListInstances": "This API is in preview release for Amazon Connect and is subject to change.
Return a list of instances which are in active state, creation-in-progress state, and failed state. Instances that aren't successfully created (they are in a failed state) are returned only for 24 hours after the CreateInstance API was invoked.
", - "ListIntegrationAssociations": "Provides summary information about the AppIntegration associations for the specified Amazon Connect instance.
", + "ListIntegrationAssociations": "Provides summary information about the AWS resource associations for the specified Amazon Connect instance.
", "ListLambdaFunctions": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all Lambda functions that display in the dropdown options in the relevant contact flow blocks.
", "ListLexBots": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all the Amazon Lex bots currently associated with the instance.
", "ListPhoneNumbers": "Provides information about the phone numbers for the specified Amazon Connect instance.
For more information about phone numbers, see Set Up Phone Numbers for Your Contact Center in the Amazon Connect Administrator Guide.
", @@ -73,13 +73,13 @@ "ListSecurityKeys": "This API is in preview release for Amazon Connect and is subject to change.
Returns a paginated list of all security keys associated with the instance.
", "ListSecurityProfiles": "Provides summary information about the security profiles for the specified Amazon Connect instance.
For more information about security profiles, see Security Profiles in the Amazon Connect Administrator Guide.
", "ListTagsForResource": "Lists the tags for the specified resource.
For sample policies that use tags, see Amazon Connect Identity-Based Policy Examples in the Amazon Connect Administrator Guide.
", - "ListUseCases": "Lists the use cases.
", + "ListUseCases": "Lists the use cases for the integration association.
", "ListUserHierarchyGroups": "Provides summary information about the hierarchy groups for the specified Amazon Connect instance.
For more information about agent hierarchies, see Set Up Agent Hierarchies in the Amazon Connect Administrator Guide.
", "ListUsers": "Provides summary information about the users for the specified Amazon Connect instance.
", "ResumeContactRecording": "When a contact is being recorded, and the recording has been suspended using SuspendContactRecording, this API resumes recording the call.
Only voice recordings are supported at this time.
", "StartChatContact": "Initiates a contact flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.
When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.
A 429 error occurs in two situations:
API rate limit is exceeded. API TPS throttling returns a TooManyRequests
exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException
.
For more information about chat, see Chat in the Amazon Connect Administrator Guide.
", "StartContactRecording": "Starts recording the contact when the agent joins the call. StartContactRecording is a one-time action. For example, if you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend and resume it, such as when collecting sensitive information (for example, a credit card number), use SuspendContactRecording and ResumeContactRecording.
You can use this API to override the recording behavior configured in the Set recording behavior block.
Only voice recordings are supported at this time.
", - "StartOutboundVoiceContact": "Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Places an outbound call to a contact, and then initiates the contact flow. It performs the actions in the contact flow that's specified (in ContactFlowId
).
Agents do not initiate the outbound API, which means that they do not dial the contact. If the contact flow places an outbound call to a contact, and then puts the contact in queue, the call is then routed to the agent, like any other inbound case.
There is a 60-second dialing timeout for this operation. If the call is not connected after 60 seconds, it fails.
UK numbers with a 447 prefix are not allowed by default. Before you can dial these UK mobile numbers, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Campaign calls are not allowed by default. Before you can make a call with TrafficType
= CAMPAIGN
, you must submit a service quota increase request. For more information, see Amazon Connect Service Quotas in the Amazon Connect Administrator Guide.
Initiates a contact flow to start a new task.
", "StopContact": "Ends the specified contact.
", "StopContactRecording": "Stops recording a call when a contact is being recorded. StopContactRecording is a one-time action. If you use StopContactRecording to stop recording an ongoing call, you can't use StartContactRecording to restart it. For scenarios where the recording has started and you want to suspend it for sensitive information (for example, to collect a credit card number), and then restart it, use SuspendContactRecording and ResumeContactRecording.
Only voice recordings are supported at this time.
", @@ -271,6 +271,12 @@ "LexV2Bot$AliasArn": "The Amazon Resource Name (ARN) of the Amazon Lex V2 bot.
" } }, + "AnswerMachineDetectionConfig": { + "base": "Configuration of the answering machine detection.
", + "refs": { + "StartOutboundVoiceContactRequest$AnswerMachineDetectionConfig": "Configuration of the answering machine detection for this outbound call.
" + } + }, "AssociateApprovedOriginRequest": { "base": null, "refs": { @@ -378,6 +384,8 @@ "Boolean": { "base": null, "refs": { + "AnswerMachineDetectionConfig$EnableAnswerMachineDetection": "The flag to indicate if answer machine detection analysis needs to be performed for a voice call. If set to true
, TrafficType
must be set as CAMPAIGN
.
Wait for the answering machine prompt.
", "UpdateAgentStatusRequest$ResetOrderNumber": "A number indicating the reset order of the agent status.
" } }, @@ -394,6 +402,12 @@ "S3Config$BucketName": "The S3 bucket name.
" } }, + "CampaignId": { + "base": null, + "refs": { + "StartOutboundVoiceContactRequest$CampaignId": "The campaign identifier of the outbound communication.
" + } + }, "Channel": { "base": null, "refs": { @@ -727,7 +741,7 @@ "CurrentMetrics": { "base": null, "refs": { - "GetCurrentMetricDataRequest$CurrentMetrics": "The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The metrics to retrieve. Specify the name and unit for each metric. The following metrics are available. For a description of all the metrics, see Real-time Metrics Definitions in the Amazon Connect Administrator Guide.
Unit: COUNT
Name in real-time metrics report: ACW
Unit: COUNT
Name in real-time metrics report: Available
Unit: COUNT
Name in real-time metrics report: Error
Unit: COUNT
Name in real-time metrics report: NPT (Non-Productive Time)
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: On contact
Unit: COUNT
Name in real-time metrics report: Online
Unit: COUNT
Name in real-time metrics report: Staffed
Unit: COUNT
Name in real-time metrics report: In queue
Unit: COUNT
Name in real-time metrics report: Scheduled
Unit: SECONDS
When you use groupings, Unit says SECONDS and the Value is returned in SECONDS.
When you do not use groupings, Unit says SECONDS but the Value is returned in MILLISECONDS. For example, if you get a response like this:
{ \"Metric\": { \"Name\": \"OLDEST_CONTACT_AGE\", \"Unit\": \"SECONDS\" }, \"Value\": 24113.0
}
The actual OLDEST_CONTACT_AGE is 24 seconds.
Name in real-time metrics report: Oldest
Unit: COUNT
Name in real-time metrics report: Active
Unit: COUNT
Name in real-time metrics report: Availability
The type of attribute.
", "DescribeInstanceAttributeRequest$AttributeType": "The type of attribute.
", - "UpdateInstanceAttributeRequest$AttributeType": "The type of attribute.
" + "UpdateInstanceAttributeRequest$AttributeType": "The type of attribute.
Only allowlisted customers can consume USE_CUSTOM_TTS_VOICES. To access this feature, contact AWS Support for allowlisting.
The identifier for the association.
", - "CreateUseCaseRequest$IntegrationAssociationId": "The identifier for the AppIntegration association.
", - "DeleteIntegrationAssociationRequest$IntegrationAssociationId": "The identifier for the AppIntegration association.
", - "DeleteUseCaseRequest$IntegrationAssociationId": "The identifier for the AppIntegration association.
", + "CreateIntegrationAssociationResponse$IntegrationAssociationId": "The identifier for the integration association.
", + "CreateUseCaseRequest$IntegrationAssociationId": "The identifier for the integration association.
", + "DeleteIntegrationAssociationRequest$IntegrationAssociationId": "The identifier for the integration association.
", + "DeleteUseCaseRequest$IntegrationAssociationId": "The identifier for the integration association.
", "IntegrationAssociationSummary$IntegrationAssociationId": "The identifier for the AppIntegration association.
", "ListUseCasesRequest$IntegrationAssociationId": "The identifier for the integration association.
" } @@ -1522,14 +1536,15 @@ "IntegrationAssociationSummaryList": { "base": null, "refs": { - "ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList": "The AppIntegration associations.
" + "ListIntegrationAssociationsResponse$IntegrationAssociationSummaryList": "The associations.
" } }, "IntegrationType": { "base": null, "refs": { "CreateIntegrationAssociationRequest$IntegrationType": "The type of information to be ingested.
", - "IntegrationAssociationSummary$IntegrationType": "The integration type.
" + "IntegrationAssociationSummary$IntegrationType": "The integration type.
", + "ListIntegrationAssociationsRequest$IntegrationType": "" } }, "InternalServiceException": { @@ -1555,7 +1570,7 @@ "KeyId": { "base": null, "refs": { - "EncryptionConfig$KeyId": "The identifier of the encryption key.
" + "EncryptionConfig$KeyId": "The full ARN of the encryption key.
Be sure to provide the full ARN of the encryption key, not just the ID.
Provides summary information about the use cases for the specified Amazon Connect AppIntegration association.
", + "base": "Provides summary information about the use cases for the specified integration association.
", "refs": { } }, @@ -2618,14 +2633,14 @@ "SourceApplicationName": { "base": null, "refs": { - "CreateIntegrationAssociationRequest$SourceApplicationName": "The name of the external application.
", + "CreateIntegrationAssociationRequest$SourceApplicationName": "The name of the external application. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceApplicationName": "The user-provided, friendly name for the external application.
" } }, "SourceType": { "base": null, "refs": { - "CreateIntegrationAssociationRequest$SourceType": "The type of the data source.
", + "CreateIntegrationAssociationRequest$SourceType": "The type of the data source. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceType": "The name of the source.
" } }, @@ -2796,10 +2811,16 @@ "InstanceSummary$CreatedTime": "When the instance was created.
" } }, + "TrafficType": { + "base": null, + "refs": { + "StartOutboundVoiceContactRequest$TrafficType": "Denotes the class of traffic. Calls with different traffic types are handled differently by Amazon Connect. The default value is GENERAL
. Use CAMPAIGN
if EnableAnswerMachineDetection
is set to true
. For all other cases, use GENERAL
.
The URL for the external application.
", + "CreateIntegrationAssociationRequest$SourceApplicationUrl": "The URL for the external application. This field is only required for the EVENT integration type.
", "IntegrationAssociationSummary$SourceApplicationUrl": "The URL for the external application.
" } }, @@ -2986,8 +3007,8 @@ "UseCaseType": { "base": null, "refs": { - "CreateUseCaseRequest$UseCaseType": "The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.
", - "UseCase$UseCaseType": "The type of use case to associate to the AppIntegration association. Each AppIntegration association can have only one of each use case type.
" + "CreateUseCaseRequest$UseCaseType": "The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
", + "UseCase$UseCaseType": "The type of use case to associate to the integration association. Each integration association can have only one of each use case type.
" } }, "User": { diff --git a/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json b/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json index 84e97f94821..bc1a1059507 100644 --- a/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json +++ b/models/apis/elasticloadbalancingv2/2015-12-01/api-2.json @@ -44,7 +44,9 @@ {"shape":"DuplicateTagKeysException"}, {"shape":"TooManyTagsException"}, {"shape":"LoadBalancerNotFoundException"}, - {"shape":"TargetGroupNotFoundException"} + {"shape":"TargetGroupNotFoundException"}, + {"shape":"ListenerNotFoundException"}, + {"shape":"RuleNotFoundException"} ] }, "CreateListener":{ @@ -165,7 +167,8 @@ "resultWrapper":"DeleteListenerResult" }, "errors":[ - {"shape":"ListenerNotFoundException"} + {"shape":"ListenerNotFoundException"}, + {"shape":"ResourceInUseException"} ] }, "DeleteLoadBalancer":{ @@ -2261,7 +2264,8 @@ "enum":[ "instance", "ip", - "lambda" + "lambda", + "alb" ] }, "TooManyActionsException":{ diff --git a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json index 7a9fb1200fa..4bc886bdfb9 100644 --- a/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json +++ b/models/apis/elasticloadbalancingv2/2015-12-01/docs-2.json @@ -647,7 +647,7 @@ "HealthCheckEnabled": { "base": null, "refs": { - "CreateTargetGroupInput$HealthCheckEnabled": "Indicates whether health checks are enabled. If the target type is lambda
, health checks are disabled by default but can be enabled. If the target type is instance
or ip
, health checks are always enabled and cannot be disabled.
Indicates whether health checks are enabled. If the target type is lambda
, health checks are disabled by default but can be enabled. If the target type is instance
, ip
, or alb
, health checks are always enabled and cannot be disabled.
Indicates whether health checks are enabled.
", "TargetGroup$HealthCheckEnabled": "Indicates whether health checks are enabled.
" } @@ -1103,7 +1103,7 @@ "CreateTargetGroupInput$Port": "The port on which the targets receive traffic. This port is used unless you specify a port override when registering the target. If the target is a Lambda function, this parameter does not apply. If the protocol is GENEVE, the supported port is 6081.
", "Listener$Port": "The port on which the load balancer is listening.
", "ModifyListenerInput$Port": "The port for connections from clients to the load balancer. You cannot specify a port for a Gateway Load Balancer.
", - "TargetDescription$Port": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. Not used if the target is a Lambda function.
", + "TargetDescription$Port": "The port on which the target is listening. If the target group protocol is GENEVE, the supported port is 6081. If the target type is alb
, the targeted Application Load Balancer must have at least one listener whose port matches the target group port. Not used if the target is a Lambda function.
The port on which the targets are listening. Not used if the target is a Lambda function.
" } }, @@ -1695,14 +1695,14 @@ "TargetId": { "base": null, "refs": { - "TargetDescription$Id": "The ID of the target. If the target type of the target group is instance
, specify an instance ID. If the target type is ip
, specify an IP address. If the target type is lambda
, specify the ARN of the Lambda function.
The ID of the target. If the target type of the target group is instance
, specify an instance ID. If the target type is ip
, specify an IP address. If the target type is lambda
, specify the ARN of the Lambda function. If the target type is alb
, specify the ARN of the Application Load Balancer target.
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
instance
- Register targets by instance ID. This is the default value.
ip
- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
lambda
- Register a single Lambda function as a target.
The type of target that you must specify when registering targets with this target group. The possible values are instance
(register targets by instance ID), ip
(register targets by IP address), or lambda
(register a single Lambda function as a target).
The type of target that you must specify when registering targets with this target group. You can't specify targets for a target group using more than one target type.
instance
- Register targets by instance ID. This is the default value.
ip
- Register targets by IP address. You can specify IP addresses from the subnets of the virtual private cloud (VPC) for the target group, the RFC 1918 range (10.0.0.0/8, 172.16.0.0/12, and 192.168.0.0/16), and the RFC 6598 range (100.64.0.0/10). You can't specify publicly routable IP addresses.
lambda
- Register a single Lambda function as a target.
alb
- Register a single Application Load Balancer as a target.
The type of target that you must specify when registering targets with this target group. The possible values are instance
(register targets by instance ID), ip
(register targets by IP address), lambda
(register a single Lambda function as a target), or alb
(register a single Application Load Balancer as a target).
The name of the Availability Zone.
", - "TargetDescription$AvailabilityZone": "An Availability Zone or all
. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance
.
If the target type is ip
and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP address is outside the VPC for the target group, the only supported value is all
.
If the target type is lambda
, this parameter is optional and the only supported value is all
.
An Availability Zone or all
. This determines whether the target receives traffic from the load balancer nodes in the specified Availability Zone or from all enabled Availability Zones for the load balancer.
This parameter is not supported if the target type of the target group is instance
or alb
.
If the target type is ip
and the IP address is in a subnet of the VPC for the target group, the Availability Zone is automatically detected and this parameter is optional. If the IP address is outside the VPC, this parameter is required.
With an Application Load Balancer, if the target type is ip
and the IP address is outside the VPC for the target group, the only supported value is all
.
If the target type is lambda
, this parameter is optional and the only supported value is all
.
Provides information about an API request or response.
", "refs" : { } }, + "ContactCenterActivity" : { + "base" : "The settings for a connect activity. This type of activity initiates a contact center call to participants.
", + "refs" : { + "Activity$ContactCenter" : "The settings for a connect activity. This type of activity initiates a contact center call to participants.
" + } + }, "CreateApplicationRequest" : { "base" : "Specifies the display name of an application and the tags to associate with the application.
", "refs" : { } @@ -820,6 +826,13 @@ "ImportJobResponse$JobStatus" : "The status of the import job. The job status is FAILED if Amazon Pinpoint wasn't able to process one or more pieces in the job.
" } }, + "JourneyChannelSettings" : { + "base" : "The channel-specific configurations for the journey.
", + "refs" : { + "JourneyResponse$JourneyChannelSettings" : "Amazon Resource Name (ARN) of the Connect Campaign.
", + "WriteJourneyRequest$JourneyChannelSettings" : "IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
" + } + }, "JourneyCustomMessage" : { "base" : "Specifies the message content for a custom channel message that's sent to participants in a journey.
", "refs" : { @@ -2092,6 +2105,7 @@ "ChannelResponse$LastModifiedDate" : "The date and time, in ISO 8601 format, when the channel was last modified.
", "ConditionalSplitActivity$FalseActivity" : "The unique identifier for the activity to perform if the conditions aren't met.
", "ConditionalSplitActivity$TrueActivity" : "The unique identifier for the activity to perform if the conditions are met.
", + "ContactCenterActivity$NextActivity" : "The unique identifier for the next activity to perform after the this activity.
", "CreateApplicationRequest$Name" : "The display name of the application. This name is displayed as the Project name on the Amazon Pinpoint console.
", "CreateRecommenderConfiguration$Description" : "A custom description of the configuration for the recommender model. The description can contain up to 128 characters. The characters can be letters, numbers, spaces, or the following symbols: _ ; () , ‐.
", "CreateRecommenderConfiguration$Name" : "A custom name of the configuration for the recommender model. The name must start with a letter or number and it can contain up to 128 characters. The characters can be letters, numbers, spaces, underscores (_), or hyphens (-).
", @@ -2279,6 +2293,9 @@ "InAppTemplateResponse$TemplateDescription" : "The description of the template.
", "InAppTemplateResponse$TemplateName" : "The name of the template.
", "InAppTemplateResponse$Version" : "The version id of the template.
", + "JourneyChannelSettings$ConnectCampaignArn" : "Amazon Resource Name (ARN) of the Connect Campaign.
", + "JourneyChannelSettings$ConnectCampaignExecutionRoleArn" : "IAM role ARN to be assumed when invoking Connect campaign execution APIs for dialing.
", + "JourneyCustomMessage$Data" : "The message content that's passed to an AWS Lambda function or to a web hook.
", "JourneyDateRangeKpiResponse$ApplicationId" : "The unique identifier for the application that the metric applies to.
", "JourneyDateRangeKpiResponse$EndTime" : "The last date and time of the date range that was used to filter the query results, in extended ISO 8601 format. The date range is inclusive.
", "JourneyDateRangeKpiResponse$JourneyId" : "The unique identifier for the journey that the metric applies to.
", diff --git a/models/apis/voice-id/2021-09-27/api-2.json b/models/apis/voice-id/2021-09-27/api-2.json new file mode 100644 index 00000000000..d287abcf7d7 --- /dev/null +++ b/models/apis/voice-id/2021-09-27/api-2.json @@ -0,0 +1,1326 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2021-09-27", + "endpointPrefix":"voiceid", + "jsonVersion":"1.0", + "protocol":"json", + "serviceFullName":"Amazon Voice ID", + "serviceId":"Voice ID", + "signatureVersion":"v4", + "signingName":"voiceid", + "targetPrefix":"VoiceID", + "uid":"voice-id-2021-09-27" + }, + "operations":{ + "CreateDomain":{ + "name":"CreateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"CreateDomainRequest"}, + "output":{"shape":"CreateDomainResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "DeleteDomain":{ + "name":"DeleteDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteDomainRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DeleteFraudster":{ + "name":"DeleteFraudster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteFraudsterRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DeleteSpeaker":{ + "name":"DeleteSpeaker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DeleteSpeakerRequest"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DescribeDomain":{ + "name":"DescribeDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeDomainRequest"}, + "output":{"shape":"DescribeDomainResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DescribeFraudster":{ + "name":"DescribeFraudster", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFraudsterRequest"}, + "output":{"shape":"DescribeFraudsterResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DescribeFraudsterRegistrationJob":{ + "name":"DescribeFraudsterRegistrationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeFraudsterRegistrationJobRequest"}, + "output":{"shape":"DescribeFraudsterRegistrationJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DescribeSpeaker":{ + "name":"DescribeSpeaker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpeakerRequest"}, + "output":{"shape":"DescribeSpeakerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "DescribeSpeakerEnrollmentJob":{ + "name":"DescribeSpeakerEnrollmentJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribeSpeakerEnrollmentJobRequest"}, + "output":{"shape":"DescribeSpeakerEnrollmentJobResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "EvaluateSession":{ + "name":"EvaluateSession", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"EvaluateSessionRequest"}, + "output":{"shape":"EvaluateSessionResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListDomains":{ + "name":"ListDomains", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListDomainsRequest"}, + "output":{"shape":"ListDomainsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListFraudsterRegistrationJobs":{ + "name":"ListFraudsterRegistrationJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListFraudsterRegistrationJobsRequest"}, + "output":{"shape":"ListFraudsterRegistrationJobsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListSpeakerEnrollmentJobs":{ + "name":"ListSpeakerEnrollmentJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSpeakerEnrollmentJobsRequest"}, + "output":{"shape":"ListSpeakerEnrollmentJobsResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListSpeakers":{ + "name":"ListSpeakers", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListSpeakersRequest"}, + "output":{"shape":"ListSpeakersResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "OptOutSpeaker":{ + "name":"OptOutSpeaker", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"OptOutSpeakerRequest"}, + "output":{"shape":"OptOutSpeakerResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "StartFraudsterRegistrationJob":{ + "name":"StartFraudsterRegistrationJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartFraudsterRegistrationJobRequest"}, + "output":{"shape":"StartFraudsterRegistrationJobResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "StartSpeakerEnrollmentJob":{ + "name":"StartSpeakerEnrollmentJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartSpeakerEnrollmentJobRequest"}, + "output":{"shape":"StartSpeakerEnrollmentJobResponse"}, + "errors":[ + {"shape":"ServiceQuotaExceededException"}, + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + }, + "UpdateDomain":{ + "name":"UpdateDomain", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"UpdateDomainRequest"}, + "output":{"shape":"UpdateDomainResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"}, + {"shape":"ValidationException"}, + {"shape":"ConflictException"}, + {"shape":"InternalServerException"}, + {"shape":"ThrottlingException"}, + {"shape":"AccessDeniedException"} + ] + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "AmazonResourceName":{ + "type":"string", + "max":1011, + "min":1, + "pattern":"^arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}$" + }, + "Arn":{ + "type":"string", + "pattern":"^arn:aws(-[^:]+)?:voiceid.+:[0-9]{12}:domain/[a-zA-Z0-9]{22}$" + }, + "AuthenticationConfiguration":{ + "type":"structure", + "required":["AcceptanceThreshold"], + "members":{ + "AcceptanceThreshold":{"shape":"Score"} + } + }, + "AuthenticationDecision":{ + "type":"string", + "enum":[ + "ACCEPT", + "REJECT", + "NOT_ENOUGH_SPEECH", + "SPEAKER_NOT_ENROLLED", + "SPEAKER_OPTED_OUT", + "SPEAKER_ID_NOT_PROVIDED" + ] + }, + "AuthenticationResult":{ + "type":"structure", + "members":{ + "AudioAggregationEndedAt":{"shape":"Timestamp"}, + "AudioAggregationStartedAt":{"shape":"Timestamp"}, + "AuthenticationResultId":{"shape":"UniqueIdLarge"}, + "Configuration":{"shape":"AuthenticationConfiguration"}, + "CustomerSpeakerId":{"shape":"CustomerSpeakerId"}, + "Decision":{"shape":"AuthenticationDecision"}, + "GeneratedSpeakerId":{"shape":"GeneratedSpeakerId"}, + "Score":{"shape":"Score"} + } + }, + "ClientTokenString":{ + "type":"string", + "max":64, + "min":1, + "pattern":"^[a-zA-Z0-9-_]+$" + }, + "ConflictException":{ + "type":"structure", + "members":{ + "ConflictType":{"shape":"ConflictType"}, + "Message":{"shape":"String"} + }, + "exception":true + }, + "ConflictType":{ + "type":"string", + "enum":[ + "ANOTHER_ACTIVE_STREAM", + "DOMAIN_NOT_ACTIVE", + "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT", + "ENROLLMENT_ALREADY_EXISTS", + "SPEAKER_NOT_SET", + "SPEAKER_OPTED_OUT", + "CONCURRENT_CHANGES" + ] + }, + "CreateDomainRequest":{ + "type":"structure", + "required":[ + "Name", + "ServerSideEncryptionConfiguration" + ], + "members":{ + "ClientToken":{ + "shape":"ClientTokenString", + "idempotencyToken":true + }, + "Description":{"shape":"Description"}, + "Name":{"shape":"DomainName"}, + "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "Tags":{"shape":"TagList"} + } + }, + "CreateDomainResponse":{ + "type":"structure", + "members":{ + "Domain":{"shape":"Domain"} + } + }, + "CustomerSpeakerId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "sensitive":true + }, + "DeleteDomainRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"} + } + }, + "DeleteFraudsterRequest":{ + "type":"structure", + "required":[ + "DomainId", + "FraudsterId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "FraudsterId":{"shape":"FraudsterId"} + } + }, + "DeleteSpeakerRequest":{ + "type":"structure", + "required":[ + "DomainId", + "SpeakerId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "SpeakerId":{"shape":"SpeakerId"} + } + }, + "DescribeDomainRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"} + } + }, + "DescribeDomainResponse":{ + "type":"structure", + "members":{ + "Domain":{"shape":"Domain"} + } + }, + "DescribeFraudsterRegistrationJobRequest":{ + "type":"structure", + "required":[ + "DomainId", + "JobId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "JobId":{"shape":"JobId"} + } + }, + "DescribeFraudsterRegistrationJobResponse":{ + "type":"structure", + "members":{ + "Job":{"shape":"FraudsterRegistrationJob"} + } + }, + "DescribeFraudsterRequest":{ + "type":"structure", + "required":[ + "DomainId", + "FraudsterId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "FraudsterId":{"shape":"FraudsterId"} + } + }, + "DescribeFraudsterResponse":{ + "type":"structure", + "members":{ + "Fraudster":{"shape":"Fraudster"} + } + }, + "DescribeSpeakerEnrollmentJobRequest":{ + "type":"structure", + "required":[ + "DomainId", + "JobId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "JobId":{"shape":"JobId"} + } + }, + "DescribeSpeakerEnrollmentJobResponse":{ + "type":"structure", + "members":{ + "Job":{"shape":"SpeakerEnrollmentJob"} + } + }, + "DescribeSpeakerRequest":{ + "type":"structure", + "required":[ + "DomainId", + "SpeakerId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "SpeakerId":{"shape":"SpeakerId"} + } + }, + "DescribeSpeakerResponse":{ + "type":"structure", + "members":{ + "Speaker":{"shape":"Speaker"} + } + }, + "Description":{ + "type":"string", + "max":1024, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-%@]*)$", + "sensitive":true + }, + "Domain":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "CreatedAt":{"shape":"Timestamp"}, + "Description":{"shape":"Description"}, + "DomainId":{"shape":"DomainId"}, + "DomainStatus":{"shape":"DomainStatus"}, + "Name":{"shape":"DomainName"}, + "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "UpdatedAt":{"shape":"Timestamp"} + } + }, + "DomainId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[a-zA-Z0-9]{22}$" + }, + "DomainName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "sensitive":true + }, + "DomainStatus":{ + "type":"string", + "enum":[ + "ACTIVE", + "PENDING", + "SUSPENDED" + ] + }, + "DomainSummaries":{ + "type":"list", + "member":{"shape":"DomainSummary"} + }, + "DomainSummary":{ + "type":"structure", + "members":{ + "Arn":{"shape":"Arn"}, + "CreatedAt":{"shape":"Timestamp"}, + "Description":{"shape":"Description"}, + "DomainId":{"shape":"DomainId"}, + "DomainStatus":{"shape":"DomainStatus"}, + "Name":{"shape":"DomainName"}, + "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "UpdatedAt":{"shape":"Timestamp"} + } + }, + "DuplicateRegistrationAction":{ + "type":"string", + "enum":[ + "SKIP", + "REGISTER_AS_NEW" + ] + }, + "EnrollmentConfig":{ + "type":"structure", + "members":{ + "ExistingEnrollmentAction":{"shape":"ExistingEnrollmentAction"}, + "FraudDetectionConfig":{"shape":"EnrollmentJobFraudDetectionConfig"} + } + }, + "EnrollmentJobFraudDetectionConfig":{ + "type":"structure", + "members":{ + "FraudDetectionAction":{"shape":"FraudDetectionAction"}, + "RiskThreshold":{"shape":"Score"} + } + }, + "EvaluateSessionRequest":{ + "type":"structure", + "required":[ + "DomainId", + "SessionNameOrId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "SessionNameOrId":{"shape":"SessionNameOrId"} + } + }, + "EvaluateSessionResponse":{ + "type":"structure", + "members":{ + "AuthenticationResult":{"shape":"AuthenticationResult"}, + "DomainId":{"shape":"DomainId"}, + "FraudDetectionResult":{"shape":"FraudDetectionResult"}, + "SessionId":{"shape":"SessionId"}, + "SessionName":{"shape":"SessionName"}, + "StreamingStatus":{"shape":"StreamingStatus"} + } + }, + "ExistingEnrollmentAction":{ + "type":"string", + "enum":[ + "SKIP", + "OVERWRITE" + ] + }, + "FailureDetails":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "StatusCode":{"shape":"Integer"} + } + }, + "FraudDetectionAction":{ + "type":"string", + "enum":[ + "IGNORE", + "FAIL" + ] + }, + "FraudDetectionConfiguration":{ + "type":"structure", + "required":["RiskThreshold"], + "members":{ + "RiskThreshold":{"shape":"Score"} + } + }, + "FraudDetectionDecision":{ + "type":"string", + "enum":[ + "HIGH_RISK", + "LOW_RISK", + "NOT_ENOUGH_SPEECH" + ] + }, + "FraudDetectionReason":{ + "type":"string", + "enum":["KNOWN_FRAUDSTER"] + }, + "FraudDetectionReasons":{ + "type":"list", + "member":{"shape":"FraudDetectionReason"}, + "max":3, + "min":0 + }, + "FraudDetectionResult":{ + "type":"structure", + "members":{ + "AudioAggregationEndedAt":{"shape":"Timestamp"}, + "AudioAggregationStartedAt":{"shape":"Timestamp"}, + "Configuration":{"shape":"FraudDetectionConfiguration"}, + "Decision":{"shape":"FraudDetectionDecision"}, + "FraudDetectionResultId":{"shape":"UniqueIdLarge"}, + "Reasons":{"shape":"FraudDetectionReasons"}, + "RiskDetails":{"shape":"FraudRiskDetails"} + } + }, + "FraudRiskDetails":{ + "type":"structure", + "required":["KnownFraudsterRisk"], + "members":{ + "KnownFraudsterRisk":{"shape":"KnownFraudsterRisk"} + } + }, + "Fraudster":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DomainId":{"shape":"DomainId"}, + "GeneratedFraudsterId":{"shape":"GeneratedFraudsterId"} + } + }, + "FraudsterId":{ + "type":"string", + "max":25, + "min":25, + "pattern":"^id#[a-zA-Z0-9]{22}$", + "sensitive":true + }, + "FraudsterRegistrationJob":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "DomainId":{"shape":"DomainId"}, + "EndedAt":{"shape":"Timestamp"}, + "FailureDetails":{"shape":"FailureDetails"}, + "InputDataConfig":{"shape":"InputDataConfig"}, + "JobId":{"shape":"JobId"}, + "JobName":{"shape":"JobName"}, + "JobProgress":{"shape":"JobProgress"}, + "JobStatus":{"shape":"FraudsterRegistrationJobStatus"}, + "OutputDataConfig":{"shape":"OutputDataConfig"}, + "RegistrationConfig":{"shape":"RegistrationConfig"} + } + }, + "FraudsterRegistrationJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "COMPLETED_WITH_ERRORS", + "FAILED" + ] + }, + "FraudsterRegistrationJobSummaries":{ + "type":"list", + "member":{"shape":"FraudsterRegistrationJobSummary"} + }, + "FraudsterRegistrationJobSummary":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DomainId":{"shape":"DomainId"}, + "EndedAt":{"shape":"Timestamp"}, + "FailureDetails":{"shape":"FailureDetails"}, + "JobId":{"shape":"JobId"}, + "JobName":{"shape":"JobName"}, + "JobProgress":{"shape":"JobProgress"}, + "JobStatus":{"shape":"FraudsterRegistrationJobStatus"} + } + }, + "GeneratedFraudsterId":{ + "type":"string", + "max":25, + "min":25, + "pattern":"^id#[a-zA-Z0-9]{22}$" + }, + "GeneratedSpeakerId":{ + "type":"string", + "max":25, + "min":25, + "pattern":"^id#[a-zA-Z0-9]{22}$" + }, + "IamRoleArn":{ + "type":"string", + "max":2048, + "min":20, + "pattern":"^arn:aws(-[^:]+)?:iam::[0-9]{12}:role/.+$" + }, + "InputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{"shape":"S3Uri"} + } + }, + "Integer":{ + "type":"integer", + "box":true + }, + "InternalServerException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true, + "fault":true + }, + "JobId":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[a-zA-Z0-9]{22}$" + }, + "JobName":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$", + "sensitive":true + }, + "JobProgress":{ + "type":"structure", + "members":{ + "PercentComplete":{"shape":"Score"} + } + }, + "KmsKeyId":{ + "type":"string", + "max":2048, + "min":1 + }, + "KnownFraudsterRisk":{ + "type":"structure", + "required":["RiskScore"], + "members":{ + "GeneratedFraudsterId":{"shape":"GeneratedFraudsterId"}, + "RiskScore":{"shape":"Score"} + } + }, + "ListDomainsRequest":{ + "type":"structure", + "members":{ + "MaxResults":{"shape":"MaxResultsForListDomainFe"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListDomainsResponse":{ + "type":"structure", + "members":{ + "DomainSummaries":{"shape":"DomainSummaries"}, + "NextToken":{"shape":"String"} + } + }, + "ListFraudsterRegistrationJobsRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"}, + "JobStatus":{"shape":"FraudsterRegistrationJobStatus"}, + "MaxResults":{"shape":"MaxResultsForList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListFraudsterRegistrationJobsResponse":{ + "type":"structure", + "members":{ + "JobSummaries":{"shape":"FraudsterRegistrationJobSummaries"}, + "NextToken":{"shape":"String"} + } + }, + "ListSpeakerEnrollmentJobsRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"}, + "JobStatus":{"shape":"SpeakerEnrollmentJobStatus"}, + "MaxResults":{"shape":"MaxResultsForList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListSpeakerEnrollmentJobsResponse":{ + "type":"structure", + "members":{ + "JobSummaries":{"shape":"SpeakerEnrollmentJobSummaries"}, + "NextToken":{"shape":"String"} + } + }, + "ListSpeakersRequest":{ + "type":"structure", + "required":["DomainId"], + "members":{ + "DomainId":{"shape":"DomainId"}, + "MaxResults":{"shape":"MaxResultsForList"}, + "NextToken":{"shape":"NextToken"} + } + }, + "ListSpeakersResponse":{ + "type":"structure", + "members":{ + "NextToken":{"shape":"String"}, + "SpeakerSummaries":{"shape":"SpeakerSummaries"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{"shape":"AmazonResourceName"} + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "Tags":{"shape":"TagList"} + } + }, + "MaxResultsForList":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "MaxResultsForListDomainFe":{ + "type":"integer", + "box":true, + "max":10, + "min":1 + }, + "NextToken":{ + "type":"string", + "max":8192, + "min":0, + "pattern":"^\\p{ASCII}{0,8192}$" + }, + "OptOutSpeakerRequest":{ + "type":"structure", + "required":[ + "DomainId", + "SpeakerId" + ], + "members":{ + "DomainId":{"shape":"DomainId"}, + "SpeakerId":{"shape":"SpeakerId"} + } + }, + "OptOutSpeakerResponse":{ + "type":"structure", + "members":{ + "Speaker":{"shape":"Speaker"} + } + }, + "OutputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "KmsKeyId":{"shape":"KmsKeyId"}, + "S3Uri":{"shape":"S3Uri"} + } + }, + "RegistrationConfig":{ + "type":"structure", + "members":{ + "DuplicateRegistrationAction":{"shape":"DuplicateRegistrationAction"}, + "FraudsterSimilarityThreshold":{"shape":"Score"} + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"}, + "ResourceType":{"shape":"ResourceType"} + }, + "exception":true + }, + "ResourceType":{ + "type":"string", + "enum":[ + "BATCH_JOB", + "COMPLIANCE_CONSENT", + "DOMAIN", + "FRAUDSTER", + "SESSION", + "SPEAKER" + ] + }, + "S3Uri":{ + "type":"string", + "max":1024, + "min":0, + "pattern":"^s3://[a-z0-9][\\.\\-a-z0-9]{1,61}[a-z0-9](/.*)?$" + }, + "Score":{ + "type":"integer", + "box":true, + "max":100, + "min":0 + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "required":["KmsKeyId"], + "members":{ + "KmsKeyId":{"shape":"KmsKeyId"} + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "SessionId":{ + "type":"string", + "max":25, + "min":25, + "pattern":"^id#[a-zA-Z0-9]{22}$" + }, + "SessionName":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^[a-zA-Z0-9][a-zA-Z0-9_-]*$" + }, + "SessionNameOrId":{ + "type":"string", + "max":36, + "min":1, + "pattern":"^(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)$" + }, + "Speaker":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "CustomerSpeakerId":{"shape":"CustomerSpeakerId"}, + "DomainId":{"shape":"DomainId"}, + "GeneratedSpeakerId":{"shape":"GeneratedSpeakerId"}, + "Status":{"shape":"SpeakerStatus"}, + "UpdatedAt":{"shape":"Timestamp"} + } + }, + "SpeakerEnrollmentJob":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "DomainId":{"shape":"DomainId"}, + "EndedAt":{"shape":"Timestamp"}, + "EnrollmentConfig":{"shape":"EnrollmentConfig"}, + "FailureDetails":{"shape":"FailureDetails"}, + "InputDataConfig":{"shape":"InputDataConfig"}, + "JobId":{"shape":"JobId"}, + "JobName":{"shape":"JobName"}, + "JobProgress":{"shape":"JobProgress"}, + "JobStatus":{"shape":"SpeakerEnrollmentJobStatus"}, + "OutputDataConfig":{"shape":"OutputDataConfig"} + } + }, + "SpeakerEnrollmentJobStatus":{ + "type":"string", + "enum":[ + "SUBMITTED", + "IN_PROGRESS", + "COMPLETED", + "COMPLETED_WITH_ERRORS", + "FAILED" + ] + }, + "SpeakerEnrollmentJobSummaries":{ + "type":"list", + "member":{"shape":"SpeakerEnrollmentJobSummary"} + }, + "SpeakerEnrollmentJobSummary":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "DomainId":{"shape":"DomainId"}, + "EndedAt":{"shape":"Timestamp"}, + "FailureDetails":{"shape":"FailureDetails"}, + "JobId":{"shape":"JobId"}, + "JobName":{"shape":"JobName"}, + "JobProgress":{"shape":"JobProgress"}, + "JobStatus":{"shape":"SpeakerEnrollmentJobStatus"} + } + }, + "SpeakerId":{ + "type":"string", + "max":256, + "min":1, + "pattern":"^(id#[a-zA-Z0-9]{22}|[a-zA-Z0-9][a-zA-Z0-9_-]*)$", + "sensitive":true + }, + "SpeakerStatus":{ + "type":"string", + "enum":[ + "ENROLLED", + "EXPIRED", + "OPTED_OUT", + "PENDING" + ] + }, + "SpeakerSummaries":{ + "type":"list", + "member":{"shape":"SpeakerSummary"} + }, + "SpeakerSummary":{ + "type":"structure", + "members":{ + "CreatedAt":{"shape":"Timestamp"}, + "CustomerSpeakerId":{"shape":"CustomerSpeakerId"}, + "DomainId":{"shape":"DomainId"}, + "GeneratedSpeakerId":{"shape":"GeneratedSpeakerId"}, + "Status":{"shape":"SpeakerStatus"}, + "UpdatedAt":{"shape":"Timestamp"} + } + }, + "StartFraudsterRegistrationJobRequest":{ + "type":"structure", + "required":[ + "DataAccessRoleArn", + "DomainId", + "InputDataConfig", + "OutputDataConfig" + ], + "members":{ + "ClientToken":{ + "shape":"ClientTokenString", + "idempotencyToken":true + }, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "DomainId":{"shape":"DomainId"}, + "InputDataConfig":{"shape":"InputDataConfig"}, + "JobName":{"shape":"JobName"}, + "OutputDataConfig":{"shape":"OutputDataConfig"}, + "RegistrationConfig":{"shape":"RegistrationConfig"} + } + }, + "StartFraudsterRegistrationJobResponse":{ + "type":"structure", + "members":{ + "Job":{"shape":"FraudsterRegistrationJob"} + } + }, + "StartSpeakerEnrollmentJobRequest":{ + "type":"structure", + "required":[ + "DataAccessRoleArn", + "DomainId", + "InputDataConfig", + "OutputDataConfig" + ], + "members":{ + "ClientToken":{ + "shape":"ClientTokenString", + "idempotencyToken":true + }, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "DomainId":{"shape":"DomainId"}, + "EnrollmentConfig":{"shape":"EnrollmentConfig"}, + "InputDataConfig":{"shape":"InputDataConfig"}, + "JobName":{"shape":"JobName"}, + "OutputDataConfig":{"shape":"OutputDataConfig"} + } + }, + "StartSpeakerEnrollmentJobResponse":{ + "type":"structure", + "members":{ + "Job":{"shape":"SpeakerEnrollmentJob"} + } + }, + "StreamingStatus":{ + "type":"string", + "enum":[ + "PENDING_CONFIGURATION", + "ONGOING", + "ENDED" + ] + }, + "String":{ + "type":"string", + "min":1 + }, + "Tag":{ + "type":"structure", + "required":[ + "Key", + "Value" + ], + "members":{ + "Key":{"shape":"TagKey"}, + "Value":{"shape":"TagValue"} + } + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":200, + "min":0 + }, + "TagList":{ + "type":"list", + "member":{"shape":"Tag"}, + "max":200, + "min":0 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "Tags" + ], + "members":{ + "ResourceArn":{"shape":"AmazonResourceName"}, + "Tags":{"shape":"TagList"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":0, + "pattern":"^([\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]*)$", + "sensitive":true + }, + "ThrottlingException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + }, + "Timestamp":{"type":"timestamp"}, + "UniqueIdLarge":{ + "type":"string", + "max":22, + "min":22, + "pattern":"^[a-zA-Z0-9]{22}$" + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "ResourceArn", + "TagKeys" + ], + "members":{ + "ResourceArn":{"shape":"AmazonResourceName"}, + "TagKeys":{"shape":"TagKeyList"} + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateDomainRequest":{ + "type":"structure", + "required":[ + "DomainId", + "Name", + "ServerSideEncryptionConfiguration" + ], + "members":{ + "Description":{"shape":"Description"}, + "DomainId":{"shape":"DomainId"}, + "Name":{"shape":"DomainName"}, + "ServerSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"} + } + }, + "UpdateDomainResponse":{ + "type":"structure", + "members":{ + "Domain":{"shape":"Domain"} + } + }, + "ValidationException":{ + "type":"structure", + "members":{ + "Message":{"shape":"String"} + }, + "exception":true + } + } +} diff --git a/models/apis/voice-id/2021-09-27/docs-2.json b/models/apis/voice-id/2021-09-27/docs-2.json new file mode 100644 index 00000000000..755633f5a28 --- /dev/null +++ b/models/apis/voice-id/2021-09-27/docs-2.json @@ -0,0 +1,830 @@ +{ + "version": "2.0", + "service": "Amazon Connect Voice ID provides real-time caller authentication and fraud screening. This guide describes the APIs used for this service.
", + "operations": { + "CreateDomain": "Creates a domain that contains all Amazon Connect Voice ID data, such as speakers, fraudsters, customer audio, and voiceprints.
", + "DeleteDomain": "Deletes the specified domain from the Amazon Connect Voice ID system.
", + "DeleteFraudster": "Deletes the specified fraudster from the Amazon Connect Voice ID system.
", + "DeleteSpeaker": "Deletes the specified speaker from the Amazon Connect Voice ID system.
", + "DescribeDomain": "Describes the specified domain.
", + "DescribeFraudster": "Describes the specified fraudster.
", + "DescribeFraudsterRegistrationJob": "Describes the specified fraudster registration job.
", + "DescribeSpeaker": "Describes the specified speaker.
", + "DescribeSpeakerEnrollmentJob": "Describes the specified speaker enrollment job.
", + "EvaluateSession": "Evaluates a specified session based on audio data accumulated during a streaming Amazon Connect Voice ID call.
", + "ListDomains": "Lists all the domains in the Amazon Web Services account.
", + "ListFraudsterRegistrationJobs": "Lists all the fraudster registration jobs in the domain with the given JobStatus
. If JobStatus
is not provided, this lists all fraudster registration jobs in the given domain.
Lists all the speaker enrollment jobs in the domain with the specified JobStatus
. If JobStatus
is not provided, this lists all jobs with all possible speaker enrollment job statuses.
Lists all speakers in a specified domain.
", + "ListTagsForResource": "Lists all tags associated with a specified Voice ID resource.
", + "OptOutSpeaker": "Opts out a speaker from Voice ID system. A speaker can be opted out regardless of whether or not they already exist in the system. If they don't yet exist, a new speaker is created in an opted out state. If they already exist, their existing status is overridden and they are opted out. Enrollment and evaluation authentication requests are rejected for opted out speakers, and opted out speakers have no voice embeddings stored in the system.
", + "StartFraudsterRegistrationJob": "Starts a new batch fraudster registration job using provided details.
", + "StartSpeakerEnrollmentJob": "Starts a new batch speaker enrollment job using specified details.
", + "TagResource": "Tags an Amazon Connect Voice ID resource with the provided list of tags.
", + "UntagResource": "Removes specified tags from a specified Amazon Connect Voice ID resource.
", + "UpdateDomain": "Updates the specified domain. This API has clobber behavior, and clears and replaces all attributes. If an optional field, such as 'Description' is not provided, it is removed from the domain.
" + }, + "shapes": { + "AccessDeniedException": { + "base": "You do not have sufficient permissions to perform this action. Check the error message and try again.
", + "refs": { + } + }, + "AmazonResourceName": { + "base": null, + "refs": { + "ListTagsForResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the Voice ID resource for which you want to list the tags.
", + "TagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the Voice ID resource you want to tag.
", + "UntagResourceRequest$ResourceArn": "The Amazon Resource Name (ARN) of the Voice ID resource you want to remove tags from.
" + } + }, + "Arn": { + "base": null, + "refs": { + "Domain$Arn": "The Amazon Resource Name (ARN) for the domain.
", + "DomainSummary$Arn": "The Amazon Resource Name (ARN) for the domain.
" + } + }, + "AuthenticationConfiguration": { + "base": "The configuration used to authenticate a speaker during a session.
", + "refs": { + "AuthenticationResult$Configuration": "The AuthenticationConfiguration
used to generate this authentication result.
The authentication decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
" + } + }, + "AuthenticationResult": { + "base": "The authentication result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
", + "refs": { + "EvaluateSessionResponse$AuthenticationResult": "Details resulting from the authentication process, such as authentication decision and authentication score.
" + } + }, + "ClientTokenString": { + "base": null, + "refs": { + "CreateDomainRequest$ClientToken": "The idempotency token for creating a new domain. If not provided, Amazon Web Services SDK populates this field.
", + "StartFraudsterRegistrationJobRequest$ClientToken": "The idempotency token for starting a new fraudster registration job. If not provided, Amazon Web Services SDK populates this field.
", + "StartSpeakerEnrollmentJobRequest$ClientToken": "The idempotency token for starting a new speaker enrollment Job. If not provided, Amazon Web Services SDK populates this field.
" + } + }, + "ConflictException": { + "base": "The request failed due to a conflict. Check the ConflictType
and error message for more details.
The type of conflict which caused a ConflictException. Possible types and the corresponding error messages are as follows:
DOMAIN_NOT_ACTIVE
: The domain is not active.
CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT
: You cannot change the speaker ID after an enrollment has been requested.
ENROLLMENT_ALREADY_EXISTS
: There is already an enrollment for this session.
SPEAKER_NOT_SET
: You must set the speaker ID before requesting an enrollment.
SPEAKER_OPTED_OUT
: You cannot request an enrollment for an opted out speaker.
CONCURRENT_CHANGES
: The request could not be processed as the resource was modified by another request during execution.
The client-provided identifier for the speaker whose authentication result is produced. Only present if a SpeakerId
is provided for the session.
The client-provided identifier for the speaker.
", + "SpeakerSummary$CustomerSpeakerId": "The client-provided identifier for the speaker.
" + } + }, + "DeleteDomainRequest": { + "base": null, + "refs": { + } + }, + "DeleteFraudsterRequest": { + "base": null, + "refs": { + } + }, + "DeleteSpeakerRequest": { + "base": null, + "refs": { + } + }, + "DescribeDomainRequest": { + "base": null, + "refs": { + } + }, + "DescribeDomainResponse": { + "base": null, + "refs": { + } + }, + "DescribeFraudsterRegistrationJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeFraudsterRegistrationJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeFraudsterRequest": { + "base": null, + "refs": { + } + }, + "DescribeFraudsterResponse": { + "base": null, + "refs": { + } + }, + "DescribeSpeakerEnrollmentJobRequest": { + "base": null, + "refs": { + } + }, + "DescribeSpeakerEnrollmentJobResponse": { + "base": null, + "refs": { + } + }, + "DescribeSpeakerRequest": { + "base": null, + "refs": { + } + }, + "DescribeSpeakerResponse": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "CreateDomainRequest$Description": "A brief description of this domain.
", + "Domain$Description": "The client-provided description of the domain.
", + "DomainSummary$Description": "The client-provided description of the domain.
", + "UpdateDomainRequest$Description": "A brief description about this domain.
" + } + }, + "Domain": { + "base": "Contains all the information about a domain.
", + "refs": { + "CreateDomainResponse$Domain": "Information about the newly created domain.
", + "DescribeDomainResponse$Domain": "Information about the specified domain.
", + "UpdateDomainResponse$Domain": "Details about the updated domain
" + } + }, + "DomainId": { + "base": null, + "refs": { + "DeleteDomainRequest$DomainId": "The identifier of the domain you want to delete.
", + "DeleteFraudsterRequest$DomainId": "The identifier of the domain containing the fraudster.
", + "DeleteSpeakerRequest$DomainId": "The identifier of the domain containing the speaker.
", + "DescribeDomainRequest$DomainId": "The identifier of the domain you are describing.
", + "DescribeFraudsterRegistrationJobRequest$DomainId": "The identifier for the domain containing the fraudster registration job.
", + "DescribeFraudsterRequest$DomainId": "The identifier of the domain containing the fraudster.
", + "DescribeSpeakerEnrollmentJobRequest$DomainId": "The identifier of the domain containing the speaker enrollment job.
", + "DescribeSpeakerRequest$DomainId": "The identifier of the domain that contains the speaker.
", + "Domain$DomainId": "The service-generated identifier for the domain.
", + "DomainSummary$DomainId": "The service-generated identifier for the domain.
", + "EvaluateSessionRequest$DomainId": "The identifier of the domain where the session started.
", + "EvaluateSessionResponse$DomainId": "The identifier of the domain containing the session.
", + "Fraudster$DomainId": "The identifier for the domain containing the fraudster.
", + "FraudsterRegistrationJob$DomainId": "The identifier of the domain containing the fraudster registration job.
", + "FraudsterRegistrationJobSummary$DomainId": "The identifier of the domain containing the fraudster registration job.
", + "ListFraudsterRegistrationJobsRequest$DomainId": "The identifier of the domain containing the fraudster registration Jobs.
", + "ListSpeakerEnrollmentJobsRequest$DomainId": "The identifier of the domain containing the speaker enrollment jobs.
", + "ListSpeakersRequest$DomainId": "The identifier of the domain.
", + "OptOutSpeakerRequest$DomainId": "The identifier of the domain containing the speaker.
", + "Speaker$DomainId": "The identifier of the domain that contains the speaker.
", + "SpeakerEnrollmentJob$DomainId": "The identifier of the domain that contains the speaker enrollment job.
", + "SpeakerEnrollmentJobSummary$DomainId": "The identifier of the domain that contains the speaker enrollment job.
", + "SpeakerSummary$DomainId": "The identifier of the domain that contains the speaker.
", + "StartFraudsterRegistrationJobRequest$DomainId": "The identifier of the domain containing the fraudster registration job and in which the fraudsters are registered.
", + "StartSpeakerEnrollmentJobRequest$DomainId": "The identifier of the domain that contains the speaker enrollment job and in which the speakers are enrolled.
", + "UpdateDomainRequest$DomainId": "The identifier of the domain to be updated.
" + } + }, + "DomainName": { + "base": null, + "refs": { + "CreateDomainRequest$Name": "The name of the domain.
", + "Domain$Name": "The client-provided name for the domain.
", + "DomainSummary$Name": "The client-provided name for the domain.
", + "UpdateDomainRequest$Name": "The name of the domain.
" + } + }, + "DomainStatus": { + "base": null, + "refs": { + "Domain$DomainStatus": "The current status of the domain.
", + "DomainSummary$DomainStatus": "The current status of the domain.
" + } + }, + "DomainSummaries": { + "base": null, + "refs": { + "ListDomainsResponse$DomainSummaries": "A list containing details about each domain in the Amazon Web Services account.
" + } + }, + "DomainSummary": { + "base": "Contains a summary of information about a domain.
", + "refs": { + "DomainSummaries$member": null + } + }, + "DuplicateRegistrationAction": { + "base": null, + "refs": { + "RegistrationConfig$DuplicateRegistrationAction": "The action to take when a fraudster is identified as a duplicate. The default action is SKIP
, which skips registering the duplicate fraudster. Setting the value to REGISTER_AS_NEW
always registers a new fraudster into the specified domain.
Contains configurations defining enrollment behavior for the batch job.
", + "refs": { + "SpeakerEnrollmentJob$EnrollmentConfig": "The configuration that defines the action to take when the speaker is already enrolled in Voice ID, and the FraudDetectionConfig
to use.
The enrollment config that contains details such as the action to take when a speaker is already enrolled in the Voice ID system or when a speaker is identified as a fraudster.
" + } + }, + "EnrollmentJobFraudDetectionConfig": { + "base": "The configuration defining the action to take when a speaker is flagged by the fraud detection system during a batch speaker enrollment job, and the risk threshold to use for identification.
", + "refs": { + "EnrollmentConfig$FraudDetectionConfig": "The fraud detection configuration to use for the speaker enrollment job.
" + } + }, + "EvaluateSessionRequest": { + "base": null, + "refs": { + } + }, + "EvaluateSessionResponse": { + "base": null, + "refs": { + } + }, + "ExistingEnrollmentAction": { + "base": null, + "refs": { + "EnrollmentConfig$ExistingEnrollmentAction": " The action to take when the specified speaker is already enrolled in the specified domain. The default value is SKIP
, which skips the enrollment for the existing speaker. Setting the value to OVERWRITE
replaces the existing voice prints and enrollment audio stored for that speaker with new data generated from the latest audio.
Contains error details for a failed batch job.
", + "refs": { + "FraudsterRegistrationJob$FailureDetails": "Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus
of COMPLETED_WITH_ERRORS
. You can use the job output file to identify the individual registration requests that failed.
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus
of COMPLETED_WITH_ERRORS
. You can use the job output file to identify the individual registration requests that failed.
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus
of COMPLETED_WITH_ERRORS
. You can use the job output file to identify the individual registration requests that failed.
Contains details that are populated when an entire batch job fails. In cases of individual registration job failures, the batch job as a whole doesn't fail; it is completed with a JobStatus
of COMPLETED_WITH_ERRORS
. You can use the job output file to identify the individual registration requests that failed.
The action to take when the given speaker is flagged by the fraud detection system. The default value is FAIL
, which fails the speaker enrollment. Changing this value to IGNORE
results in the speaker being enrolled even if they are flagged by the fraud detection system.
The configuration used for performing fraud detection over a speaker during a session.
", + "refs": { + "FraudDetectionResult$Configuration": "The FraudDetectionConfiguration
used to generate this fraud detection result.
The fraud detection decision produced by Voice ID, processed against the current session state and streamed audio of the speaker.
" + } + }, + "FraudDetectionReason": { + "base": null, + "refs": { + "FraudDetectionReasons$member": null + } + }, + "FraudDetectionReasons": { + "base": null, + "refs": { + "FraudDetectionResult$Reasons": "The reason speaker was flagged by the fraud detection system. This is only be populated if fraud detection Decision is HIGH_RISK
, and only has one possible value: KNOWN_FRAUDSTER
.
The fraud detection result produced by Voice ID, processed against the current session state and streamed audio of the speaker.
", + "refs": { + "EvaluateSessionResponse$FraudDetectionResult": "Details resulting from the fraud detection process, such as fraud detection decision and risk score.
" + } + }, + "FraudRiskDetails": { + "base": "Details regarding various fraud risk analyses performed against the current session state and streamed audio of the speaker.
", + "refs": { + "FraudDetectionResult$RiskDetails": "Details about each risk analyzed for this speaker.
" + } + }, + "Fraudster": { + "base": "Contains all the information about a fraudster.
", + "refs": { + "DescribeFraudsterResponse$Fraudster": "Information about the specified fraudster.
" + } + }, + "FraudsterId": { + "base": null, + "refs": { + "DeleteFraudsterRequest$FraudsterId": "The identifier of the fraudster you want to delete.
", + "DescribeFraudsterRequest$FraudsterId": "The identifier of the fraudster you are describing.
" + } + }, + "FraudsterRegistrationJob": { + "base": "Contains all the information about a fraudster registration job.
", + "refs": { + "DescribeFraudsterRegistrationJobResponse$Job": "Contains details about the specified fraudster registration job.
", + "StartFraudsterRegistrationJobResponse$Job": "Details about the started fraudster registration job.
" + } + }, + "FraudsterRegistrationJobStatus": { + "base": null, + "refs": { + "FraudsterRegistrationJob$JobStatus": "The current status of the fraudster registration job.
", + "FraudsterRegistrationJobSummary$JobStatus": "The current status of the fraudster registration job.
", + "ListFraudsterRegistrationJobsRequest$JobStatus": "Provides the status of your fraudster registration job.
" + } + }, + "FraudsterRegistrationJobSummaries": { + "base": null, + "refs": { + "ListFraudsterRegistrationJobsResponse$JobSummaries": "A list containing details about each specified fraudster registration job.
" + } + }, + "FraudsterRegistrationJobSummary": { + "base": "Contains a summary of information about a fraudster registration job.
", + "refs": { + "FraudsterRegistrationJobSummaries$member": null + } + }, + "GeneratedFraudsterId": { + "base": null, + "refs": { + "Fraudster$GeneratedFraudsterId": "The service-generated identifier for the fraudster.
", + "KnownFraudsterRisk$GeneratedFraudsterId": "The identifier of the fraudster that is the closest match to the speaker. If there are no fraudsters registered in a given domain, or if there are no fraudsters with a non-zero RiskScore, this value is null
.
The service-generated identifier for the speaker whose authentication result is produced.
", + "Speaker$GeneratedSpeakerId": "The service-generated identifier for the speaker.
", + "SpeakerSummary$GeneratedSpeakerId": "The service-generated identifier for the speaker.
" + } + }, + "IamRoleArn": { + "base": null, + "refs": { + "FraudsterRegistrationJob$DataAccessRoleArn": "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.
", + "SpeakerEnrollmentJob$DataAccessRoleArn": "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.
", + "StartFraudsterRegistrationJobRequest$DataAccessRoleArn": "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 the Create and edit a fraudster watchlist documentation for the permissions needed in this role.
", + "StartSpeakerEnrollmentJobRequest$DataAccessRoleArn": "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 Batch enrollment using audio data from prior calls documentation for the permissions needed in this role.
" + } + }, + "InputDataConfig": { + "base": "The configuration containing input file information for a batch job.
", + "refs": { + "FraudsterRegistrationJob$InputDataConfig": "The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration job requests.
", + "SpeakerEnrollmentJob$InputDataConfig": "The input data config containing an S3 URI for the input manifest file that contains the list of speaker enrollment job requests.
", + "StartFraudsterRegistrationJobRequest$InputDataConfig": "The input data config containing an S3 URI for the input manifest file that contains the list of fraudster registration requests.
", + "StartSpeakerEnrollmentJobRequest$InputDataConfig": "The input data config containing the S3 location for the input manifest file that contains the list of speaker enrollment requests.
" + } + }, + "Integer": { + "base": null, + "refs": { + "FailureDetails$StatusCode": "An HTTP status code representing the nature of the error.
" + } + }, + "InternalServerException": { + "base": "The request failed due to an unknown error on the server side.
", + "refs": { + } + }, + "JobId": { + "base": null, + "refs": { + "DescribeFraudsterRegistrationJobRequest$JobId": "The identifier for the fraudster registration job you are describing.
", + "DescribeSpeakerEnrollmentJobRequest$JobId": "The identifier of the speaker enrollment job you are describing.
", + "FraudsterRegistrationJob$JobId": "The service-generated identifier for the fraudster registration job.
", + "FraudsterRegistrationJobSummary$JobId": "The service-generated identifier for the fraudster registration job.
", + "SpeakerEnrollmentJob$JobId": "The service-generated identifier for the speaker enrollment job.
", + "SpeakerEnrollmentJobSummary$JobId": "The service-generated identifier for the speaker enrollment job.
" + } + }, + "JobName": { + "base": null, + "refs": { + "FraudsterRegistrationJob$JobName": "The client-provied name for the fraudster registration job.
", + "FraudsterRegistrationJobSummary$JobName": "The client-provied name for the fraudster registration job.
", + "SpeakerEnrollmentJob$JobName": "The client-provided name for the speaker enrollment job.
", + "SpeakerEnrollmentJobSummary$JobName": "The client-provided name for the speaker enrollment job.
", + "StartFraudsterRegistrationJobRequest$JobName": "The name of the new fraudster registration job.
", + "StartSpeakerEnrollmentJobRequest$JobName": "A name for your speaker enrollment job.
" + } + }, + "JobProgress": { + "base": "Indicates the completion progress for a batch job.
", + "refs": { + "FraudsterRegistrationJob$JobProgress": "Shows the completed percentage of registration requests listed in the input file.
", + "FraudsterRegistrationJobSummary$JobProgress": "Shows the completed percentage of registration requests listed in the input file.
", + "SpeakerEnrollmentJob$JobProgress": "Provides details on job progress. This field shows the completed percentage of registration requests listed in the input file.
", + "SpeakerEnrollmentJobSummary$JobProgress": "Provides details regarding job progress. This field shows the completed percentage of enrollment requests listed in the input file.
" + } + }, + "KmsKeyId": { + "base": null, + "refs": { + "OutputDataConfig$KmsKeyId": "the identifier of the KMS key you want Voice ID to use to encrypt the output file of the fraudster registration job.
", + "ServerSideEncryptionConfiguration$KmsKeyId": "The identifier of the KMS Key you want Voice ID to use to encrypt your data.
" + } + }, + "KnownFraudsterRisk": { + "base": "Contains details produced as a result of performing known fraudster risk analysis on a speaker.
", + "refs": { + "FraudRiskDetails$KnownFraudsterRisk": "The details resulting from 'Known Fraudster Risk' analysis of the speaker.
" + } + }, + "ListDomainsRequest": { + "base": null, + "refs": { + } + }, + "ListDomainsResponse": { + "base": null, + "refs": { + } + }, + "ListFraudsterRegistrationJobsRequest": { + "base": null, + "refs": { + } + }, + "ListFraudsterRegistrationJobsResponse": { + "base": null, + "refs": { + } + }, + "ListSpeakerEnrollmentJobsRequest": { + "base": null, + "refs": { + } + }, + "ListSpeakerEnrollmentJobsResponse": { + "base": null, + "refs": { + } + }, + "ListSpeakersRequest": { + "base": null, + "refs": { + } + }, + "ListSpeakersResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MaxResultsForList": { + "base": null, + "refs": { + "ListFraudsterRegistrationJobsRequest$MaxResults": "The maximum number of results that are returned per call. You can use NextToken
to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
The maximum number of results that are returned per call. You can use NextToken
to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
The maximum number of results that are returned per call. You can use NextToken
to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
The maximum number of results that are returned per call. You can use NextToken
to obtain further pages of results. The default is 100; the maximum allowed page size is also 100.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
The configuration containing output file information for a batch job.
", + "refs": { + "FraudsterRegistrationJob$OutputDataConfig": "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.
", + "SpeakerEnrollmentJob$OutputDataConfig": "The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
", + "StartFraudsterRegistrationJobRequest$OutputDataConfig": "The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
", + "StartSpeakerEnrollmentJobRequest$OutputDataConfig": "The output data config containing the S3 location where Voice ID writes the job output file; you must also include a KMS Key ID to encrypt the file.
" + } + }, + "RegistrationConfig": { + "base": "The configuration definining the action to take when a duplicate fraudster is detected, and the similarity threshold to use for detecting a duplicate fraudster during a batch fraudster registration job.
", + "refs": { + "FraudsterRegistrationJob$RegistrationConfig": "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.
", + "StartFraudsterRegistrationJobRequest$RegistrationConfig": "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.
" + } + }, + "ResourceNotFoundException": { + "base": "The specified resource cannot be found. Check the ResourceType
and error message for more details.
The type of resource which cannot not be found. Possible types are BATCH_JOB
, COMPLIANCE_CONSENT
, DOMAIN
, FRAUDSTER
, SESSION
and SPEAKER
.
The S3 location for the input manifest file that contains the list of individual enrollment or registration job requests.
", + "OutputDataConfig$S3Uri": "The S3 path of the folder to which Voice ID writes the job output file, which has a *.out
extension. For example, if the input file name is input-file.json
and the output folder path is s3://output-bucket/output-folder
, the full output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out
.
The minimum threshold needed to successfully authenticate a speaker.
", + "AuthenticationResult$Score": "The authentication score for the speaker whose authentication result is produced. This value is only present if the authentication decision is either ACCEPT
or REJECT
.
Threshold value for determining whether the speaker is a high risk to be fraudulent. If the detected risk score calculated by Voice ID is greater than or equal to the threshold, the speaker is considered a fraudster.
", + "FraudDetectionConfiguration$RiskThreshold": "Threshold value for determining whether the speaker is a fraudster. If the detected risk score calculated by Voice ID is higher than the threshold, the speaker is considered a fraudster.
", + "JobProgress$PercentComplete": "Shows the completed percentage of enrollment or registration requests listed in the input file.
", + "KnownFraudsterRisk$RiskScore": "The score indicating the likelihood the speaker is a known fraudster.
", + "RegistrationConfig$FraudsterSimilarityThreshold": "The minimum similarity score between the new and old fraudsters in order to consider the new fraudster a duplicate.
" + } + }, + "ServerSideEncryptionConfiguration": { + "base": "The configuration containing information about the customer-managed KMS Key used for encrypting customer data.
", + "refs": { + "CreateDomainRequest$ServerSideEncryptionConfiguration": "The configuration, containing the KMS Key Identifier, to be used by Voice ID for the server-side encryption of your data. Refer to Amazon Connect VoiceID encryption at rest for more details on how the KMS Key is used.
", + "Domain$ServerSideEncryptionConfiguration": "The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data.
", + "DomainSummary$ServerSideEncryptionConfiguration": "The server-side encryption configuration containing the KMS Key Identifier you want Voice ID to use to encrypt your data..
", + "UpdateDomainRequest$ServerSideEncryptionConfiguration": "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.
" + } + }, + "ServiceQuotaExceededException": { + "base": "The request exceeded the service quota. Refer to Voice ID Service Quotas and try your request again.
", + "refs": { + } + }, + "SessionId": { + "base": null, + "refs": { + "EvaluateSessionResponse$SessionId": "The service-generated identifier of the session.
" + } + }, + "SessionName": { + "base": null, + "refs": { + "EvaluateSessionResponse$SessionName": "The client-provided name of the session.
" + } + }, + "SessionNameOrId": { + "base": null, + "refs": { + "EvaluateSessionRequest$SessionNameOrId": "The session identifier, or name of the session, that you want to evaluate. In Voice ID integration, this is the Contact-Id.
" + } + }, + "Speaker": { + "base": "Contains all the information about a speaker.
", + "refs": { + "DescribeSpeakerResponse$Speaker": "Information about the specified speaker.
", + "OptOutSpeakerResponse$Speaker": "Details about the opted-out speaker.
" + } + }, + "SpeakerEnrollmentJob": { + "base": "Contains all the information about a speaker enrollment job.
", + "refs": { + "DescribeSpeakerEnrollmentJobResponse$Job": "Contains details about the specified speaker enrollment job.
", + "StartSpeakerEnrollmentJobResponse$Job": "Details about the started speaker enrollment job.
" + } + }, + "SpeakerEnrollmentJobStatus": { + "base": null, + "refs": { + "ListSpeakerEnrollmentJobsRequest$JobStatus": "Provides the status of your speaker enrollment Job.
", + "SpeakerEnrollmentJob$JobStatus": "The current status of the speaker enrollment job.
", + "SpeakerEnrollmentJobSummary$JobStatus": "The current status of the speaker enrollment job.
" + } + }, + "SpeakerEnrollmentJobSummaries": { + "base": null, + "refs": { + "ListSpeakerEnrollmentJobsResponse$JobSummaries": "A list containing details about each specified speaker enrollment job.
" + } + }, + "SpeakerEnrollmentJobSummary": { + "base": "Contains a summary of information about a speaker enrollment job.
", + "refs": { + "SpeakerEnrollmentJobSummaries$member": null + } + }, + "SpeakerId": { + "base": null, + "refs": { + "DeleteSpeakerRequest$SpeakerId": "The identifier of the speaker you want to delete.
", + "DescribeSpeakerRequest$SpeakerId": "The identifier of the speaker you are describing.
", + "OptOutSpeakerRequest$SpeakerId": "The identifier of the speaker you want opted-out.
" + } + }, + "SpeakerStatus": { + "base": null, + "refs": { + "Speaker$Status": "The current status of the speaker.
", + "SpeakerSummary$Status": "The current status of the speaker.
" + } + }, + "SpeakerSummaries": { + "base": null, + "refs": { + "ListSpeakersResponse$SpeakerSummaries": "A list containing details about each speaker in the Amazon Web Services account.
" + } + }, + "SpeakerSummary": { + "base": "Contains a summary of information about a speaker.
", + "refs": { + "SpeakerSummaries$member": null + } + }, + "StartFraudsterRegistrationJobRequest": { + "base": null, + "refs": { + } + }, + "StartFraudsterRegistrationJobResponse": { + "base": null, + "refs": { + } + }, + "StartSpeakerEnrollmentJobRequest": { + "base": null, + "refs": { + } + }, + "StartSpeakerEnrollmentJobResponse": { + "base": null, + "refs": { + } + }, + "StreamingStatus": { + "base": null, + "refs": { + "EvaluateSessionResponse$StreamingStatus": "The current status of audio streaming for this session. This field is useful to infer next steps when the Authentication or Fraud Detection results are empty or the decision is NOT_ENOUGH_SPEECH
. In this situation, if the StreamingStatus
is ONGOING/PENDING_CONFIGURATION
, it can mean that the client should call the API again later, once Voice ID has enough audio to produce a result. If the decision remains NOT_ENOUGH_SPEECH
even after StreamingStatus
is ENDED
, it means that the previously streamed session did not have enough speech to perform evaluation, and a new streaming session is needed to try again.
A description of the error that caused the batch job failure.
", + "InternalServerException$Message": null, + "ListDomainsResponse$NextToken": "If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
If NextToken
is returned, there are more results available. The value of NextToken
is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours.
A tag that can be assigned to a Voice ID resource.
", + "refs": { + "TagList$member": null + } + }, + "TagKey": { + "base": null, + "refs": { + "Tag$Key": "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'.
", + "TagKeyList$member": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$TagKeys": "The list of tag keys you want to remove from the specified resource.
" + } + }, + "TagList": { + "base": null, + "refs": { + "CreateDomainRequest$Tags": "A list of tags you want added to the domain.
", + "ListTagsForResourceResponse$Tags": "The list of tags associated with the specified resource.
", + "TagResourceRequest$Tags": "The list of tags to assign to the specified resource.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tag$Value": "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'.
" + } + }, + "ThrottlingException": { + "base": "The request was denied due to request throttling. Please slow down your request rate. Refer to Amazon Connect Voice ID Service API throttling quotas and try your request again.
", + "refs": { + } + }, + "Timestamp": { + "base": null, + "refs": { + "AuthenticationResult$AudioAggregationEndedAt": "A timestamp indicating when audio aggregation ended for this authentication result.
", + "AuthenticationResult$AudioAggregationStartedAt": "A timestamp indicating when audio aggregation started for this authentication result.
", + "Domain$CreatedAt": "The timestamp at which the domain is created.
", + "Domain$UpdatedAt": "The timestamp showing the domain's last update.
", + "DomainSummary$CreatedAt": "The timestamp showing when the domain is created.
", + "DomainSummary$UpdatedAt": "The timestamp showing the domain's last update.
", + "FraudDetectionResult$AudioAggregationEndedAt": "A timestamp indicating when audio aggregation ended for this fraud detection result.
", + "FraudDetectionResult$AudioAggregationStartedAt": "A timestamp indicating when audio aggregation started for this fraud detection result.
", + "Fraudster$CreatedAt": "The timestamp when Voice ID identified the fraudster.
", + "FraudsterRegistrationJob$CreatedAt": "A timestamp showing the creation time of the fraudster registration job.
", + "FraudsterRegistrationJob$EndedAt": "A timestamp showing when the fraudster registration job ended.
", + "FraudsterRegistrationJobSummary$CreatedAt": "A timestamp showing when the fraudster registration job is created.
", + "FraudsterRegistrationJobSummary$EndedAt": "A timestamp showing when the fraudster registration job ended.
", + "Speaker$CreatedAt": "A timestamp showing when the speaker is created.
", + "Speaker$UpdatedAt": "A timestamp showing the speaker's last update.
", + "SpeakerEnrollmentJob$CreatedAt": "A timestamp showing the creation of the speaker enrollment job.
", + "SpeakerEnrollmentJob$EndedAt": "A timestamp showing when the speaker enrollment job ended.
", + "SpeakerEnrollmentJobSummary$CreatedAt": "A timestamp showing the creation time of the speaker enrollment job.
", + "SpeakerEnrollmentJobSummary$EndedAt": "A timestamp showing when the speaker enrollment job ended.
", + "SpeakerSummary$CreatedAt": "A timestamp showing the speaker's creation time.
", + "SpeakerSummary$UpdatedAt": "A timestamp showing the speaker's last update.
" + } + }, + "UniqueIdLarge": { + "base": null, + "refs": { + "AuthenticationResult$AuthenticationResultId": "The unique identifier for this authentication result. Because there can be multiple authentications for a given session, this field helps to identify if the returned result is from a previous streaming activity or a new result. Note that in absence of any new streaming activity, AcceptanceThreshold
changes, or SpeakerId
changes, Voice ID always returns cached Authentication Result for this API.
The unique identifier for this fraud detection result. Given there can be multiple fraud detections for a given session, this field helps in identifying if the returned result is from previous streaming activity or a new result. Note that in the absence of any new streaming activity or risk threshold changes, Voice ID always returns cached Fraud Detection result for this API.
" + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateDomainRequest": { + "base": null, + "refs": { + } + }, + "UpdateDomainResponse": { + "base": null, + "refs": { + } + }, + "ValidationException": { + "base": "The request failed one or more validations; check the error message for more details.
", + "refs": { + } + } + } +} diff --git a/models/apis/voice-id/2021-09-27/examples-1.json b/models/apis/voice-id/2021-09-27/examples-1.json new file mode 100644 index 00000000000..0ea7e3b0bbe --- /dev/null +++ b/models/apis/voice-id/2021-09-27/examples-1.json @@ -0,0 +1,5 @@ +{ + "version": "1.0", + "examples": { + } +} diff --git a/models/apis/voice-id/2021-09-27/paginators-1.json b/models/apis/voice-id/2021-09-27/paginators-1.json new file mode 100644 index 00000000000..65ed93352fb --- /dev/null +++ b/models/apis/voice-id/2021-09-27/paginators-1.json @@ -0,0 +1,24 @@ +{ + "pagination": { + "ListDomains": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListFraudsterRegistrationJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSpeakerEnrollmentJobs": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + }, + "ListSpeakers": { + "input_token": "NextToken", + "output_token": "NextToken", + "limit_key": "MaxResults" + } + } +} diff --git a/models/apis/wisdom/2020-10-19/api-2.json b/models/apis/wisdom/2020-10-19/api-2.json new file mode 100644 index 00000000000..664d7837bd5 --- /dev/null +++ b/models/apis/wisdom/2020-10-19/api-2.json @@ -0,0 +1,1945 @@ +{ + "version":"2.0", + "metadata":{ + "apiVersion":"2020-10-19", + "endpointPrefix":"wisdom", + "jsonVersion":"1.1", + "protocol":"rest-json", + "serviceFullName":"Amazon Connect Wisdom Service", + "serviceId":"Wisdom", + "signatureVersion":"v4", + "signingName":"wisdom", + "uid":"wisdom-2020-10-19" + }, + "operations":{ + "CreateAssistant":{ + "name":"CreateAssistant", + "http":{ + "method":"POST", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantRequest"}, + "output":{"shape":"CreateAssistantResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "CreateAssistantAssociation":{ + "name":"CreateAssistantAssociation", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"CreateAssistantAssociationRequest"}, + "output":{"shape":"CreateAssistantAssociationResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "CreateContent":{ + "name":"CreateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"CreateContentRequest"}, + "output":{"shape":"CreateContentResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "CreateKnowledgeBase":{ + "name":"CreateKnowledgeBase", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"CreateKnowledgeBaseRequest"}, + "output":{"shape":"CreateKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ServiceQuotaExceededException"}, + {"shape":"AccessDeniedException"} + ], + "idempotent":true + }, + "CreateSession":{ + "name":"CreateSession", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions", + "responseCode":200 + }, + "input":{"shape":"CreateSessionRequest"}, + "output":{"shape":"CreateSessionResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"ValidationException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DeleteAssistant":{ + "name":"DeleteAssistant", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantRequest"}, + "output":{"shape":"DeleteAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DeleteAssistantAssociation":{ + "name":"DeleteAssistantAssociation", + "http":{ + "method":"DELETE", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":204 + }, + "input":{"shape":"DeleteAssistantAssociationRequest"}, + "output":{"shape":"DeleteAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DeleteContent":{ + "name":"DeleteContent", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":204 + }, + "input":{"shape":"DeleteContentRequest"}, + "output":{"shape":"DeleteContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "DeleteKnowledgeBase":{ + "name":"DeleteKnowledgeBase", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":204 + }, + "input":{"shape":"DeleteKnowledgeBaseRequest"}, + "output":{"shape":"DeleteKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ConflictException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "GetAssistant":{ + "name":"GetAssistant", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantRequest"}, + "output":{"shape":"GetAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetAssistantAssociation":{ + "name":"GetAssistantAssociation", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations/{assistantAssociationId}", + "responseCode":200 + }, + "input":{"shape":"GetAssistantAssociationRequest"}, + "output":{"shape":"GetAssistantAssociationResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetContent":{ + "name":"GetContent", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"GetContentRequest"}, + "output":{"shape":"GetContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetContentSummary":{ + "name":"GetContentSummary", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary", + "responseCode":200 + }, + "input":{"shape":"GetContentSummaryRequest"}, + "output":{"shape":"GetContentSummaryResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetKnowledgeBase":{ + "name":"GetKnowledgeBase", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}", + "responseCode":200 + }, + "input":{"shape":"GetKnowledgeBaseRequest"}, + "output":{"shape":"GetKnowledgeBaseResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetRecommendations":{ + "name":"GetRecommendations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations", + "responseCode":200 + }, + "input":{"shape":"GetRecommendationsRequest"}, + "output":{"shape":"GetRecommendationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "GetSession":{ + "name":"GetSession", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}", + "responseCode":200 + }, + "input":{"shape":"GetSessionRequest"}, + "output":{"shape":"GetSessionResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListAssistantAssociations":{ + "name":"ListAssistantAssociations", + "http":{ + "method":"GET", + "requestUri":"/assistants/{assistantId}/associations", + "responseCode":200 + }, + "input":{"shape":"ListAssistantAssociationsRequest"}, + "output":{"shape":"ListAssistantAssociationsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListAssistants":{ + "name":"ListAssistants", + "http":{ + "method":"GET", + "requestUri":"/assistants", + "responseCode":200 + }, + "input":{"shape":"ListAssistantsRequest"}, + "output":{"shape":"ListAssistantsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListContents":{ + "name":"ListContents", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents", + "responseCode":200 + }, + "input":{"shape":"ListContentsRequest"}, + "output":{"shape":"ListContentsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "ListKnowledgeBases":{ + "name":"ListKnowledgeBases", + "http":{ + "method":"GET", + "requestUri":"/knowledgeBases", + "responseCode":200 + }, + "input":{"shape":"ListKnowledgeBasesRequest"}, + "output":{"shape":"ListKnowledgeBasesResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"} + ] + }, + "ListTagsForResource":{ + "name":"ListTagsForResource", + "http":{ + "method":"GET", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"ListTagsForResourceRequest"}, + "output":{"shape":"ListTagsForResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ] + }, + "NotifyRecommendationsReceived":{ + "name":"NotifyRecommendationsReceived", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify", + "responseCode":200 + }, + "input":{"shape":"NotifyRecommendationsReceivedRequest"}, + "output":{"shape":"NotifyRecommendationsReceivedResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "QueryAssistant":{ + "name":"QueryAssistant", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/query", + "responseCode":200 + }, + "input":{"shape":"QueryAssistantRequest"}, + "output":{"shape":"QueryAssistantResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "RemoveKnowledgeBaseTemplateUri":{ + "name":"RemoveKnowledgeBaseTemplateUri", + "http":{ + "method":"DELETE", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":204 + }, + "input":{"shape":"RemoveKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"RemoveKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "SearchContent":{ + "name":"SearchContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/search", + "responseCode":200 + }, + "input":{"shape":"SearchContentRequest"}, + "output":{"shape":"SearchContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "SearchSessions":{ + "name":"SearchSessions", + "http":{ + "method":"POST", + "requestUri":"/assistants/{assistantId}/searchSessions", + "responseCode":200 + }, + "input":{"shape":"SearchSessionsRequest"}, + "output":{"shape":"SearchSessionsResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "StartContentUpload":{ + "name":"StartContentUpload", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/upload", + "responseCode":200 + }, + "input":{"shape":"StartContentUploadRequest"}, + "output":{"shape":"StartContentUploadResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "TagResource":{ + "name":"TagResource", + "http":{ + "method":"POST", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"TagResourceRequest"}, + "output":{"shape":"TagResourceResponse"}, + "errors":[ + {"shape":"TooManyTagsException"}, + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "UntagResource":{ + "name":"UntagResource", + "http":{ + "method":"DELETE", + "requestUri":"/tags/{resourceArn}", + "responseCode":200 + }, + "input":{"shape":"UntagResourceRequest"}, + "output":{"shape":"UntagResourceResponse"}, + "errors":[ + {"shape":"ResourceNotFoundException"} + ], + "idempotent":true + }, + "UpdateContent":{ + "name":"UpdateContent", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/contents/{contentId}", + "responseCode":200 + }, + "input":{"shape":"UpdateContentRequest"}, + "output":{"shape":"UpdateContentResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"PreconditionFailedException"}, + {"shape":"ResourceNotFoundException"} + ] + }, + "UpdateKnowledgeBaseTemplateUri":{ + "name":"UpdateKnowledgeBaseTemplateUri", + "http":{ + "method":"POST", + "requestUri":"/knowledgeBases/{knowledgeBaseId}/templateUri", + "responseCode":200 + }, + "input":{"shape":"UpdateKnowledgeBaseTemplateUriRequest"}, + "output":{"shape":"UpdateKnowledgeBaseTemplateUriResponse"}, + "errors":[ + {"shape":"ValidationException"}, + {"shape":"AccessDeniedException"}, + {"shape":"ResourceNotFoundException"} + ] + } + }, + "shapes":{ + "AccessDeniedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{ + "httpStatusCode":403, + "senderFault":true + }, + "exception":true + }, + "AppIntegrationsConfiguration":{ + "type":"structure", + "required":[ + "appIntegrationArn", + "objectFields" + ], + "members":{ + "appIntegrationArn":{"shape":"GenericArn"}, + "objectFields":{"shape":"ObjectFieldsList"} + } + }, + "Arn":{ + "type":"string", + "pattern":"^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + }, + "AssistantAssociationData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{"shape":"Arn"}, + "assistantAssociationArn":{"shape":"Arn"}, + "assistantAssociationId":{"shape":"Uuid"}, + "assistantId":{"shape":"Uuid"}, + "associationData":{"shape":"AssistantAssociationOutputData"}, + "associationType":{"shape":"AssociationType"}, + "tags":{"shape":"Tags"} + } + }, + "AssistantAssociationInputData":{ + "type":"structure", + "members":{ + "knowledgeBaseId":{"shape":"Uuid"} + }, + "union":true + }, + "AssistantAssociationOutputData":{ + "type":"structure", + "members":{ + "knowledgeBaseAssociation":{"shape":"KnowledgeBaseAssociationData"} + }, + "union":true + }, + "AssistantAssociationSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantAssociationArn", + "assistantAssociationId", + "assistantId", + "associationData", + "associationType" + ], + "members":{ + "assistantArn":{"shape":"Arn"}, + "assistantAssociationArn":{"shape":"Arn"}, + "assistantAssociationId":{"shape":"Uuid"}, + "assistantId":{"shape":"Uuid"}, + "associationData":{"shape":"AssistantAssociationOutputData"}, + "associationType":{"shape":"AssociationType"}, + "tags":{"shape":"Tags"} + } + }, + "AssistantAssociationSummaryList":{ + "type":"list", + "member":{"shape":"AssistantAssociationSummary"} + }, + "AssistantData":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{"shape":"Arn"}, + "assistantId":{"shape":"Uuid"}, + "description":{"shape":"Description"}, + "name":{"shape":"Name"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "status":{"shape":"AssistantStatus"}, + "tags":{"shape":"Tags"}, + "type":{"shape":"AssistantType"} + } + }, + "AssistantList":{ + "type":"list", + "member":{"shape":"AssistantSummary"} + }, + "AssistantStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "AssistantSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "name", + "status", + "type" + ], + "members":{ + "assistantArn":{"shape":"Arn"}, + "assistantId":{"shape":"Uuid"}, + "description":{"shape":"Description"}, + "name":{"shape":"Name"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "status":{"shape":"AssistantStatus"}, + "tags":{"shape":"Tags"}, + "type":{"shape":"AssistantType"} + } + }, + "AssistantType":{ + "type":"string", + "enum":["AGENT"] + }, + "AssociationType":{ + "type":"string", + "enum":["KNOWLEDGE_BASE"] + }, + "Boolean":{ + "type":"boolean", + "box":true + }, + "ClientToken":{ + "type":"string", + "max":4096, + "min":1 + }, + "ConflictException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{ + "httpStatusCode":409, + "senderFault":true + }, + "exception":true + }, + "ContentData":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title", + "url", + "urlExpiry" + ], + "members":{ + "contentArn":{"shape":"Arn"}, + "contentId":{"shape":"Uuid"}, + "contentType":{"shape":"ContentType"}, + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"}, + "linkOutUri":{"shape":"Uri"}, + "metadata":{"shape":"ContentMetadata"}, + "name":{"shape":"Name"}, + "revisionId":{"shape":"NonEmptyString"}, + "status":{"shape":"ContentStatus"}, + "tags":{"shape":"Tags"}, + "title":{"shape":"ContentTitle"}, + "url":{"shape":"SyntheticContentDataUrl"}, + "urlExpiry":{"shape":"SyntheticTimestamp_epoch_seconds"} + } + }, + "ContentMetadata":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "ContentReference":{ + "type":"structure", + "members":{ + "contentArn":{"shape":"Arn"}, + "contentId":{"shape":"Uuid"}, + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"} + } + }, + "ContentStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED", + "UPDATE_FAILED" + ] + }, + "ContentSummary":{ + "type":"structure", + "required":[ + "contentArn", + "contentId", + "contentType", + "knowledgeBaseArn", + "knowledgeBaseId", + "metadata", + "name", + "revisionId", + "status", + "title" + ], + "members":{ + "contentArn":{"shape":"Arn"}, + "contentId":{"shape":"Uuid"}, + "contentType":{"shape":"ContentType"}, + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"}, + "metadata":{"shape":"ContentMetadata"}, + "name":{"shape":"Name"}, + "revisionId":{"shape":"NonEmptyString"}, + "status":{"shape":"ContentStatus"}, + "tags":{"shape":"Tags"}, + "title":{"shape":"ContentTitle"} + } + }, + "ContentSummaryList":{ + "type":"list", + "member":{"shape":"ContentSummary"} + }, + "ContentTitle":{ + "type":"string", + "max":255, + "min":1 + }, + "ContentType":{ + "type":"string", + "pattern":"^(text/(plain|html))|(application/x\\.wisdom-json;source=(salesforce|servicenow))$" + }, + "CreateAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantId", + "association", + "associationType" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "association":{"shape":"AssistantAssociationInputData"}, + "associationType":{"shape":"AssociationType"}, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "tags":{"shape":"Tags"} + } + }, + "CreateAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{"shape":"AssistantAssociationData"} + } + }, + "CreateAssistantRequest":{ + "type":"structure", + "required":[ + "name", + "type" + ], + "members":{ + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"Description"}, + "name":{"shape":"Name"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "tags":{"shape":"Tags"}, + "type":{"shape":"AssistantType"} + } + }, + "CreateAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{"shape":"AssistantData"} + } + }, + "CreateContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "name", + "uploadId" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "idempotencyToken":true + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{"shape":"ContentMetadata"}, + "name":{"shape":"Name"}, + "overrideLinkOutUri":{"shape":"Uri"}, + "tags":{"shape":"Tags"}, + "title":{"shape":"ContentTitle"}, + "uploadId":{"shape":"NonEmptyString"} + } + }, + "CreateContentResponse":{ + "type":"structure", + "members":{ + "content":{"shape":"ContentData"} + } + }, + "CreateKnowledgeBaseRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseType", + "name" + ], + "members":{ + "clientToken":{ + "shape":"NonEmptyString", + "idempotencyToken":true + }, + "description":{"shape":"Description"}, + "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, + "name":{"shape":"Name"}, + "renderingConfiguration":{"shape":"RenderingConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "sourceConfiguration":{"shape":"SourceConfiguration"}, + "tags":{"shape":"Tags"} + } + }, + "CreateKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{"shape":"KnowledgeBaseData"} + } + }, + "CreateSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "name" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "clientToken":{ + "shape":"ClientToken", + "idempotencyToken":true + }, + "description":{"shape":"Description"}, + "name":{"shape":"Name"}, + "tags":{"shape":"Tags"} + } + }, + "CreateSessionResponse":{ + "type":"structure", + "members":{ + "session":{"shape":"SessionData"} + } + }, + "DeleteAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantAssociationResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "DeleteAssistantResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteContentResponse":{ + "type":"structure", + "members":{ + } + }, + "DeleteKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "DeleteKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + } + }, + "Description":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "Document":{ + "type":"structure", + "required":["contentReference"], + "members":{ + "contentReference":{"shape":"ContentReference"}, + "excerpt":{"shape":"DocumentText"}, + "title":{"shape":"DocumentText"} + } + }, + "DocumentText":{ + "type":"structure", + "members":{ + "highlights":{"shape":"Highlights"}, + "text":{"shape":"SyntheticDocumentTextString"} + } + }, + "Filter":{ + "type":"structure", + "required":[ + "field", + "operator", + "value" + ], + "members":{ + "field":{"shape":"FilterField"}, + "operator":{"shape":"FilterOperator"}, + "value":{"shape":"NonEmptyString"} + } + }, + "FilterField":{ + "type":"string", + "enum":["NAME"] + }, + "FilterList":{ + "type":"list", + "member":{"shape":"Filter"} + }, + "FilterOperator":{ + "type":"string", + "enum":["EQUALS"] + }, + "GenericArn":{ + "type":"string", + "max":2048, + "min":1, + "pattern":"^arn:[a-z-]+?:[a-z-]+?:[a-z0-9-]*?:([0-9]{12})?:[a-zA-Z0-9-:/]+$" + }, + "GetAssistantAssociationRequest":{ + "type":"structure", + "required":[ + "assistantAssociationId", + "assistantId" + ], + "members":{ + "assistantAssociationId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantAssociationId" + }, + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantAssociationResponse":{ + "type":"structure", + "members":{ + "assistantAssociation":{"shape":"AssistantAssociationData"} + } + }, + "GetAssistantRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + } + } + }, + "GetAssistantResponse":{ + "type":"structure", + "members":{ + "assistant":{"shape":"AssistantData"} + } + }, + "GetContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentResponse":{ + "type":"structure", + "members":{ + "content":{"shape":"ContentData"} + } + }, + "GetContentSummaryRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetContentSummaryResponse":{ + "type":"structure", + "members":{ + "contentSummary":{"shape":"ContentSummary"} + } + }, + "GetKnowledgeBaseRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "GetKnowledgeBaseResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{"shape":"KnowledgeBaseData"} + } + }, + "GetRecommendationsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "sessionId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"sessionId" + }, + "waitTimeSeconds":{ + "shape":"WaitTimeSeconds", + "location":"querystring", + "locationName":"waitTimeSeconds" + } + } + }, + "GetRecommendationsResponse":{ + "type":"structure", + "required":["recommendations"], + "members":{ + "recommendations":{"shape":"RecommendationList"} + } + }, + "GetSessionRequest":{ + "type":"structure", + "required":[ + "assistantId", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "sessionId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "GetSessionResponse":{ + "type":"structure", + "members":{ + "session":{"shape":"SessionData"} + } + }, + "Headers":{ + "type":"map", + "key":{"shape":"NonEmptyString"}, + "value":{"shape":"NonEmptyString"} + }, + "Highlight":{ + "type":"structure", + "members":{ + "beginOffsetInclusive":{"shape":"HighlightOffset"}, + "endOffsetExclusive":{"shape":"HighlightOffset"} + } + }, + "HighlightOffset":{"type":"integer"}, + "Highlights":{ + "type":"list", + "member":{"shape":"Highlight"} + }, + "KnowledgeBaseAssociationData":{ + "type":"structure", + "members":{ + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"} + } + }, + "KnowledgeBaseData":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{"shape":"Description"}, + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"}, + "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, + "lastContentModificationTime":{"shape":"SyntheticTimestamp_epoch_seconds"}, + "name":{"shape":"Name"}, + "renderingConfiguration":{"shape":"RenderingConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "sourceConfiguration":{"shape":"SourceConfiguration"}, + "status":{"shape":"KnowledgeBaseStatus"}, + "tags":{"shape":"Tags"} + } + }, + "KnowledgeBaseList":{ + "type":"list", + "member":{"shape":"KnowledgeBaseSummary"} + }, + "KnowledgeBaseStatus":{ + "type":"string", + "enum":[ + "CREATE_IN_PROGRESS", + "CREATE_FAILED", + "ACTIVE", + "DELETE_IN_PROGRESS", + "DELETE_FAILED", + "DELETED" + ] + }, + "KnowledgeBaseSummary":{ + "type":"structure", + "required":[ + "knowledgeBaseArn", + "knowledgeBaseId", + "knowledgeBaseType", + "name", + "status" + ], + "members":{ + "description":{"shape":"Description"}, + "knowledgeBaseArn":{"shape":"Arn"}, + "knowledgeBaseId":{"shape":"Uuid"}, + "knowledgeBaseType":{"shape":"KnowledgeBaseType"}, + "name":{"shape":"Name"}, + "renderingConfiguration":{"shape":"RenderingConfiguration"}, + "serverSideEncryptionConfiguration":{"shape":"ServerSideEncryptionConfiguration"}, + "sourceConfiguration":{"shape":"SourceConfiguration"}, + "status":{"shape":"KnowledgeBaseStatus"}, + "tags":{"shape":"Tags"} + } + }, + "KnowledgeBaseType":{ + "type":"string", + "enum":[ + "EXTERNAL", + "CUSTOM" + ] + }, + "ListAssistantAssociationsRequest":{ + "type":"structure", + "required":["assistantId"], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantAssociationsResponse":{ + "type":"structure", + "required":["assistantAssociationSummaries"], + "members":{ + "assistantAssociationSummaries":{"shape":"AssistantAssociationSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListAssistantsRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListAssistantsResponse":{ + "type":"structure", + "required":["assistantSummaries"], + "members":{ + "assistantSummaries":{"shape":"AssistantList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListContentsRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListContentsResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{"shape":"ContentSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "ListKnowledgeBasesRequest":{ + "type":"structure", + "members":{ + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NonEmptyString", + "location":"querystring", + "locationName":"nextToken" + } + } + }, + "ListKnowledgeBasesResponse":{ + "type":"structure", + "required":["knowledgeBaseSummaries"], + "members":{ + "knowledgeBaseSummaries":{"shape":"KnowledgeBaseList"}, + "nextToken":{"shape":"NonEmptyString"} + } + }, + "ListTagsForResourceRequest":{ + "type":"structure", + "required":["resourceArn"], + "members":{ + "resourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"resourceArn" + } + } + }, + "ListTagsForResourceResponse":{ + "type":"structure", + "members":{ + "tags":{"shape":"Tags"} + } + }, + "MaxResults":{ + "type":"integer", + "box":true, + "max":100, + "min":1 + }, + "Name":{ + "type":"string", + "max":255, + "min":1, + "pattern":"^[a-zA-Z0-9\\s_.,-]+" + }, + "NextToken":{ + "type":"string", + "max":2048, + "min":1 + }, + "NonEmptyString":{ + "type":"string", + "max":4096, + "min":1 + }, + "NotifyRecommendationsReceivedError":{ + "type":"structure", + "members":{ + "message":{"shape":"NotifyRecommendationsReceivedErrorMessage"}, + "recommendationId":{"shape":"String"} + } + }, + "NotifyRecommendationsReceivedErrorList":{ + "type":"list", + "member":{"shape":"NotifyRecommendationsReceivedError"} + }, + "NotifyRecommendationsReceivedErrorMessage":{"type":"string"}, + "NotifyRecommendationsReceivedRequest":{ + "type":"structure", + "required":[ + "assistantId", + "recommendationIds", + "sessionId" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "recommendationIds":{"shape":"RecommendationIdList"}, + "sessionId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"sessionId" + } + } + }, + "NotifyRecommendationsReceivedResponse":{ + "type":"structure", + "members":{ + "errors":{"shape":"NotifyRecommendationsReceivedErrorList"}, + "recommendationIds":{"shape":"RecommendationIdList"} + } + }, + "ObjectFieldsList":{ + "type":"list", + "member":{"shape":"NonEmptyString"}, + "max":100, + "min":1 + }, + "PreconditionFailedException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{ + "httpStatusCode":412, + "senderFault":true + }, + "exception":true + }, + "QueryAssistantRequest":{ + "type":"structure", + "required":[ + "assistantId", + "queryText" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{"shape":"MaxResults"}, + "nextToken":{"shape":"NextToken"}, + "queryText":{"shape":"QueryText"} + } + }, + "QueryAssistantResponse":{ + "type":"structure", + "required":["results"], + "members":{ + "nextToken":{"shape":"NextToken"}, + "results":{"shape":"QueryResultsList"} + } + }, + "QueryResultsList":{ + "type":"list", + "member":{"shape":"ResultData"} + }, + "QueryText":{ + "type":"string", + "sensitive":true + }, + "RecommendationData":{ + "type":"structure", + "required":[ + "document", + "recommendationId" + ], + "members":{ + "document":{"shape":"Document"}, + "recommendationId":{"shape":"String"}, + "relevanceLevel":{"shape":"RelevanceLevel"}, + "relevanceScore":{"shape":"RelevanceScore"} + } + }, + "RecommendationIdList":{ + "type":"list", + "member":{"shape":"String"} + }, + "RecommendationList":{ + "type":"list", + "member":{"shape":"RecommendationData"} + }, + "RelevanceLevel":{ + "type":"string", + "enum":[ + "HIGH", + "MEDIUM", + "LOW" + ] + }, + "RelevanceScore":{ + "type":"double", + "min":0.0 + }, + "RemoveKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":["knowledgeBaseId"], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "RemoveKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + } + }, + "RenderingConfiguration":{ + "type":"structure", + "members":{ + "templateUri":{"shape":"Uri"} + } + }, + "ResourceNotFoundException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{"shape":"String"} + }, + "error":{ + "httpStatusCode":404, + "senderFault":true + }, + "exception":true + }, + "ResultData":{ + "type":"structure", + "required":[ + "document", + "resultId" + ], + "members":{ + "document":{"shape":"Document"}, + "relevanceScore":{"shape":"RelevanceScore"}, + "resultId":{"shape":"Uuid"} + } + }, + "SearchContentRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "searchExpression" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{"shape":"SearchExpression"} + } + }, + "SearchContentResponse":{ + "type":"structure", + "required":["contentSummaries"], + "members":{ + "contentSummaries":{"shape":"ContentSummaryList"}, + "nextToken":{"shape":"NextToken"} + } + }, + "SearchExpression":{ + "type":"structure", + "required":["filters"], + "members":{ + "filters":{"shape":"FilterList"} + } + }, + "SearchSessionsRequest":{ + "type":"structure", + "required":[ + "assistantId", + "searchExpression" + ], + "members":{ + "assistantId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"assistantId" + }, + "maxResults":{ + "shape":"MaxResults", + "location":"querystring", + "locationName":"maxResults" + }, + "nextToken":{ + "shape":"NextToken", + "location":"querystring", + "locationName":"nextToken" + }, + "searchExpression":{"shape":"SearchExpression"} + } + }, + "SearchSessionsResponse":{ + "type":"structure", + "required":["sessionSummaries"], + "members":{ + "nextToken":{"shape":"NextToken"}, + "sessionSummaries":{"shape":"SessionSummaries"} + } + }, + "ServerSideEncryptionConfiguration":{ + "type":"structure", + "members":{ + "kmsKeyId":{"shape":"NonEmptyString"} + } + }, + "ServiceQuotaExceededException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{ + "httpStatusCode":402, + "senderFault":true + }, + "exception":true + }, + "SessionData":{ + "type":"structure", + "required":[ + "name", + "sessionArn", + "sessionId" + ], + "members":{ + "description":{"shape":"Description"}, + "name":{"shape":"Name"}, + "sessionArn":{"shape":"Arn"}, + "sessionId":{"shape":"Uuid"}, + "tags":{"shape":"Tags"} + } + }, + "SessionSummaries":{ + "type":"list", + "member":{"shape":"SessionSummary"} + }, + "SessionSummary":{ + "type":"structure", + "required":[ + "assistantArn", + "assistantId", + "sessionArn", + "sessionId" + ], + "members":{ + "assistantArn":{"shape":"Arn"}, + "assistantId":{"shape":"Uuid"}, + "sessionArn":{"shape":"Arn"}, + "sessionId":{"shape":"Uuid"} + } + }, + "SourceConfiguration":{ + "type":"structure", + "members":{ + "appIntegrations":{"shape":"AppIntegrationsConfiguration"} + }, + "union":true + }, + "StartContentUploadRequest":{ + "type":"structure", + "required":[ + "contentType", + "knowledgeBaseId" + ], + "members":{ + "contentType":{"shape":"ContentType"}, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + } + } + }, + "StartContentUploadResponse":{ + "type":"structure", + "required":[ + "headersToInclude", + "uploadId", + "url", + "urlExpiry" + ], + "members":{ + "headersToInclude":{"shape":"Headers"}, + "uploadId":{"shape":"NonEmptyString"}, + "url":{"shape":"SyntheticStartContentUploadResponseUrl"}, + "urlExpiry":{"shape":"SyntheticTimestamp_epoch_seconds"} + } + }, + "String":{"type":"string"}, + "SyntheticContentDataUrl":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true + }, + "SyntheticDocumentTextString":{ + "type":"string", + "sensitive":true + }, + "SyntheticStartContentUploadResponseUrl":{ + "type":"string", + "max":4096, + "min":1, + "sensitive":true + }, + "SyntheticTimestamp_epoch_seconds":{ + "type":"timestamp", + "timestampFormat":"unixTimestamp" + }, + "TagKey":{ + "type":"string", + "max":128, + "min":1, + "pattern":"^(?!aws:)[a-zA-Z+-=._:/]+$" + }, + "TagKeyList":{ + "type":"list", + "member":{"shape":"TagKey"}, + "max":50, + "min":1 + }, + "TagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tags" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"resourceArn" + }, + "tags":{"shape":"Tags"} + } + }, + "TagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "TagValue":{ + "type":"string", + "max":256, + "min":1 + }, + "Tags":{ + "type":"map", + "key":{"shape":"TagKey"}, + "value":{"shape":"TagValue"} + }, + "TooManyTagsException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"}, + "resourceName":{"shape":"String"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "UntagResourceRequest":{ + "type":"structure", + "required":[ + "resourceArn", + "tagKeys" + ], + "members":{ + "resourceArn":{ + "shape":"Arn", + "location":"uri", + "locationName":"resourceArn" + }, + "tagKeys":{ + "shape":"TagKeyList", + "location":"querystring", + "locationName":"tagKeys" + } + } + }, + "UntagResourceResponse":{ + "type":"structure", + "members":{ + } + }, + "UpdateContentRequest":{ + "type":"structure", + "required":[ + "contentId", + "knowledgeBaseId" + ], + "members":{ + "contentId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"contentId" + }, + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "metadata":{"shape":"ContentMetadata"}, + "overrideLinkOutUri":{"shape":"Uri"}, + "removeOverrideLinkOutUri":{"shape":"Boolean"}, + "revisionId":{"shape":"NonEmptyString"}, + "title":{"shape":"ContentTitle"}, + "uploadId":{"shape":"NonEmptyString"} + } + }, + "UpdateContentResponse":{ + "type":"structure", + "members":{ + "content":{"shape":"ContentData"} + } + }, + "UpdateKnowledgeBaseTemplateUriRequest":{ + "type":"structure", + "required":[ + "knowledgeBaseId", + "templateUri" + ], + "members":{ + "knowledgeBaseId":{ + "shape":"UuidOrArn", + "location":"uri", + "locationName":"knowledgeBaseId" + }, + "templateUri":{"shape":"Uri"} + } + }, + "UpdateKnowledgeBaseTemplateUriResponse":{ + "type":"structure", + "members":{ + "knowledgeBase":{"shape":"KnowledgeBaseData"} + } + }, + "Uri":{ + "type":"string", + "max":4096, + "min":1 + }, + "Uuid":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$" + }, + "UuidOrArn":{ + "type":"string", + "pattern":"^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12})?$" + }, + "ValidationException":{ + "type":"structure", + "members":{ + "message":{"shape":"String"} + }, + "error":{ + "httpStatusCode":400, + "senderFault":true + }, + "exception":true + }, + "WaitTimeSeconds":{ + "type":"integer", + "max":20, + "min":0 + } + } +} diff --git a/models/apis/wisdom/2020-10-19/docs-2.json b/models/apis/wisdom/2020-10-19/docs-2.json new file mode 100644 index 00000000000..e28adc1f81e --- /dev/null +++ b/models/apis/wisdom/2020-10-19/docs-2.json @@ -0,0 +1,1045 @@ +{ + "version": "2.0", + "service": "All Amazon Connect Wisdom functionality is accessible using the API. For example, you can create an assistant and a knowledge base.
<p>Some more advanced features are only accessible using the Wisdom API. For example, you can manually manage content by uploading custom files and control their lifecycle. </p>
",
+ "operations": {
+ "CreateAssistant": "Creates an Amazon Connect Wisdom assistant.
", + "CreateAssistantAssociation": "Creates an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.
", + "CreateContent": "Creates Wisdom content. Before to calling this API, use StartContentUpload to upload an asset.
", + "CreateKnowledgeBase": "Creates a knowledge base.
When using this API, you cannot reuse Amazon AppIntegrations DataIntegrations with external knowledge bases such as Salesforce and ServiceNow. If you do, you'll get an InvalidRequestException
error.
<p>For example, you're programmatically managing your external knowledge base, and you want to add or remove one of the fields that is being ingested from Salesforce. Do the following:</p> <ol> <li> <p>Call <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_DeleteKnowledgeBase.html">DeleteKnowledgeBase</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_DeleteDataIntegration.html">DeleteDataIntegration</a>.</p> </li> <li> <p>Call <a href="https://docs.aws.amazon.com/appintegrations/latest/APIReference/API_CreateDataIntegration.html">CreateDataIntegration</a> to recreate the DataIntegration or a create different one.</p> </li> <li> <p>Call CreateKnowledgeBase.</p> </li> </ol> </note>
",
+ "CreateSession": "Creates a session. A session is a contextual container used for generating recommendations. Amazon Connect creates a new Wisdom session for each contact on which Wisdom is enabled.
", + "DeleteAssistant": "Deletes an assistant.
", + "DeleteAssistantAssociation": "Deletes an assistant association.
", + "DeleteContent": "Deletes the content.
", + "DeleteKnowledgeBase": "Deletes the knowledge base.
When you use this API to delete an external knowledge base such as Salesforce or ServiceNow, you must also delete the Amazon AppIntegrations DataIntegration. This is because you can't reuse the DataIntegration after it's been associated with an external knowledge base. However, you can delete and recreate it. See DeleteDataIntegration and CreateDataIntegration in the Amazon AppIntegrations API Reference.
Retrieves information about an assistant.
", + "GetAssistantAssociation": "Retrieves information about an assistant association.
", + "GetContent": "Retrieves content, including a pre-signed URL to download the content.
", + "GetContentSummary": "Retrieves summary information about the content.
", + "GetKnowledgeBase": "Retrieves information about the knowledge base.
", + "GetRecommendations": "Retrieves recommendations for the specified session. To avoid retrieving the same recommendations in subsequent calls, use NotifyRecommendationsReceived. This API supports long-polling behavior with the waitTimeSeconds
parameter. Short poll is the default behavior and only returns recommendations already available. To perform a manual query against an assistant, use QueryAssistant.
Retrieves information for a specified session.
", + "ListAssistantAssociations": "Lists information about assistant associations.
", + "ListAssistants": "Lists information about assistants.
", + "ListContents": "Lists the content.
", + "ListKnowledgeBases": "Lists the knowledge bases.
", + "ListTagsForResource": "Lists the tags for the specified resource.
", + "NotifyRecommendationsReceived": "Removes the specified recommendations from the specified assistant's queue of newly available recommendations. You can use this API in conjunction with GetRecommendations and a waitTimeSeconds
input for long-polling behavior and avoiding duplicate recommendations.
Performs a manual search against the specified assistant. To retrieve recommendations for an assistant, use GetRecommendations.
", + "RemoveKnowledgeBaseTemplateUri": "Removes a URI template from a knowledge base.
", + "SearchContent": "Searches for content in a specified knowledge base. Can be used to get a specific content resource by its name.
", + "SearchSessions": "Searches for sessions.
", + "StartContentUpload": "Get a URL to upload content to a knowledge base. To upload content, first make a PUT request to the returned URL with your file, making sure to include the required headers. Then use CreateContent to finalize the content creation process or UpdateContent to modify an existing resource. You can only upload content to a knowledge base of type CUSTOM.
", + "TagResource": "Adds the specified tags to the specified resource.
", + "UntagResource": "Removes the specified tags from the specified resource.
", + "UpdateContent": "Updates information about the content.
", + "UpdateKnowledgeBaseTemplateUri": "Updates the template URI of a knowledge base. This is only supported for knowledge bases of type EXTERNAL. Include a single variable in ${variable}
format; this interpolated by Wisdom using ingested content. For example, if you ingest a Salesforce article, it has an Id
value, and you can set the template URI to https://myInstanceName.lightning.force.com/lightning/r/Knowledge__kav/*${Id}*/view
.
You do not have sufficient access to perform this action.
", + "refs": { + } + }, + "AppIntegrationsConfiguration": { + "base": "Configuration information for Amazon AppIntegrations to automatically ingest content.
", + "refs": { + "SourceConfiguration$appIntegrations": "Configuration information for Amazon AppIntegrations to automatically ingest content.
" + } + }, + "Arn": { + "base": null, + "refs": { + "AssistantAssociationData$assistantArn": "The Amazon Resource Name (ARN) of the Wisdom assistant
", + "AssistantAssociationData$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", + "AssistantAssociationSummary$assistantArn": "The Amazon Resource Name (ARN) of the Wisdom assistant
", + "AssistantAssociationSummary$assistantAssociationArn": "The Amazon Resource Name (ARN) of the assistant association.
", + "AssistantData$assistantArn": "The Amazon Resource Name (ARN) of the Wisdom assistant
", + "AssistantSummary$assistantArn": "The Amazon Resource Name (ARN) of the Wisdom assistant
", + "ContentData$contentArn": "The Amazon Resource Name (ARN) of the content.
", + "ContentData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "ContentReference$contentArn": "The Amazon Resource Name (ARN) of the content.
", + "ContentReference$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "ContentSummary$contentArn": "The Amazon Resource Name (ARN) of the content.
", + "ContentSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "KnowledgeBaseAssociationData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "KnowledgeBaseData$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "KnowledgeBaseSummary$knowledgeBaseArn": "The Amazon Resource Name (ARN) of the knowledge base.
", + "ListTagsForResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "SessionData$sessionArn": "The Amazon Resource Name (ARN) of the session.
", + "SessionSummary$assistantArn": "The Amazon Resource Name (ARN) of the Wisdom assistant
", + "SessionSummary$sessionArn": "The Amazon Resource Name (ARN) of the session.
", + "TagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
", + "UntagResourceRequest$resourceArn": "The Amazon Resource Name (ARN) of the resource.
" + } + }, + "AssistantAssociationData": { + "base": "Information about the assistant association.
", + "refs": { + "CreateAssistantAssociationResponse$assistantAssociation": "The assistant association.
", + "GetAssistantAssociationResponse$assistantAssociation": "The assistant association.
" + } + }, + "AssistantAssociationInputData": { + "base": "The data that is input into Wisdom as a result of the assistant association.
", + "refs": { + "CreateAssistantAssociationRequest$association": "The identifier of the associated resource.
" + } + }, + "AssistantAssociationOutputData": { + "base": "The data that is output as a result of the assistant association.
", + "refs": { + "AssistantAssociationData$associationData": "A union type that currently has a single argument, the knowledge base ID.
", + "AssistantAssociationSummary$associationData": "The association data.
" + } + }, + "AssistantAssociationSummary": { + "base": "Summary information about the assistant association.
", + "refs": { + "AssistantAssociationSummaryList$member": null + } + }, + "AssistantAssociationSummaryList": { + "base": null, + "refs": { + "ListAssistantAssociationsResponse$assistantAssociationSummaries": "Summary information about assistant associations.
" + } + }, + "AssistantData": { + "base": "The assistant data.
", + "refs": { + "CreateAssistantResponse$assistant": "Information about the assistant.
", + "GetAssistantResponse$assistant": "Information about the assistant.
" + } + }, + "AssistantList": { + "base": null, + "refs": { + "ListAssistantsResponse$assistantSummaries": "Information about the assistants.
" + } + }, + "AssistantStatus": { + "base": null, + "refs": { + "AssistantData$status": "The status of the assistant.
", + "AssistantSummary$status": "The status of the assistant.
" + } + }, + "AssistantSummary": { + "base": "Summary information about the assistant.
", + "refs": { + "AssistantList$member": null + } + }, + "AssistantType": { + "base": null, + "refs": { + "AssistantData$type": "The type of assistant.
", + "AssistantSummary$type": "The type of the assistant.
", + "CreateAssistantRequest$type": "The type of assistant.
" + } + }, + "AssociationType": { + "base": null, + "refs": { + "AssistantAssociationData$associationType": "The type of association.
", + "AssistantAssociationSummary$associationType": "The type of association.
", + "CreateAssistantAssociationRequest$associationType": "The type of association.
" + } + }, + "Boolean": { + "base": null, + "refs": { + "UpdateContentRequest$removeOverrideLinkOutUri": "Unset the existing overrideLinkOutUri
if it exists.
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateAssistantRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateSessionRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" + } + }, + "ConflictException": { + "base": "The request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create
API (such as CreateAssistant
) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.
Information about the content.
", + "refs": { + "CreateContentResponse$content": "The content.
", + "GetContentResponse$content": "The content.
", + "UpdateContentResponse$content": "The content.
" + } + }, + "ContentMetadata": { + "base": null, + "refs": { + "ContentData$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
", + "ContentSummary$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
", + "CreateContentRequest$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
", + "UpdateContentRequest$metadata": "A key/value map to store attributes without affecting tagging or recommendations. For example, when synchronizing data between an external system and Wisdom, you can store an external version identifier as metadata to utilize for determining drift.
" + } + }, + "ContentReference": { + "base": "Reference information about the content.
", + "refs": { + "Document$contentReference": "A reference to the content resource.
" + } + }, + "ContentStatus": { + "base": null, + "refs": { + "ContentData$status": "The status of the content.
", + "ContentSummary$status": "The status of the content.
" + } + }, + "ContentSummary": { + "base": "Summary information about the content.
", + "refs": { + "ContentSummaryList$member": null, + "GetContentSummaryResponse$contentSummary": "The content summary.
" + } + }, + "ContentSummaryList": { + "base": null, + "refs": { + "ListContentsResponse$contentSummaries": "Information about the content.
", + "SearchContentResponse$contentSummaries": "Summary information about the content.
" + } + }, + "ContentTitle": { + "base": null, + "refs": { + "ContentData$title": "The title of the content.
", + "ContentSummary$title": "The title of the content.
", + "CreateContentRequest$title": "The title of the content. If not set, the title is equal to the name.
", + "UpdateContentRequest$title": "The title of the content.
" + } + }, + "ContentType": { + "base": null, + "refs": { + "ContentData$contentType": "The media type of the content.
", + "ContentSummary$contentType": "The media type of the content.
", + "StartContentUploadRequest$contentType": "The type of content to upload.
" + } + }, + "CreateAssistantAssociationRequest": { + "base": null, + "refs": { + } + }, + "CreateAssistantAssociationResponse": { + "base": null, + "refs": { + } + }, + "CreateAssistantRequest": { + "base": null, + "refs": { + } + }, + "CreateAssistantResponse": { + "base": null, + "refs": { + } + }, + "CreateContentRequest": { + "base": null, + "refs": { + } + }, + "CreateContentResponse": { + "base": null, + "refs": { + } + }, + "CreateKnowledgeBaseRequest": { + "base": null, + "refs": { + } + }, + "CreateKnowledgeBaseResponse": { + "base": null, + "refs": { + } + }, + "CreateSessionRequest": { + "base": null, + "refs": { + } + }, + "CreateSessionResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssistantAssociationRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssistantAssociationResponse": { + "base": null, + "refs": { + } + }, + "DeleteAssistantRequest": { + "base": null, + "refs": { + } + }, + "DeleteAssistantResponse": { + "base": null, + "refs": { + } + }, + "DeleteContentRequest": { + "base": null, + "refs": { + } + }, + "DeleteContentResponse": { + "base": null, + "refs": { + } + }, + "DeleteKnowledgeBaseRequest": { + "base": null, + "refs": { + } + }, + "DeleteKnowledgeBaseResponse": { + "base": null, + "refs": { + } + }, + "Description": { + "base": null, + "refs": { + "AssistantData$description": "The description.
", + "AssistantSummary$description": "The description of the assistant.
", + "CreateAssistantRequest$description": "The description of the assistant.
", + "CreateKnowledgeBaseRequest$description": "The description.
", + "CreateSessionRequest$description": "The description.
", + "KnowledgeBaseData$description": "The description.
", + "KnowledgeBaseSummary$description": "The description of the knowledge base.
", + "SessionData$description": "The description of the session.
" + } + }, + "Document": { + "base": "The document.
", + "refs": { + "RecommendationData$document": "The recommended document.
", + "ResultData$document": "The document.
" + } + }, + "DocumentText": { + "base": "The text of the document.
", + "refs": { + "Document$excerpt": "The excerpt from the document.
", + "Document$title": "The title of the document.
" + } + }, + "Filter": { + "base": "A search filter.
", + "refs": { + "FilterList$member": null + } + }, + "FilterField": { + "base": null, + "refs": { + "Filter$field": "The field on which to filter.
" + } + }, + "FilterList": { + "base": null, + "refs": { + "SearchExpression$filters": "The search expression filters.
" + } + }, + "FilterOperator": { + "base": null, + "refs": { + "Filter$operator": "The operator to use for comparing the field’s value with the provided value.
" + } + }, + "GenericArn": { + "base": null, + "refs": { + "AppIntegrationsConfiguration$appIntegrationArn": "The Amazon Resource Name (ARN) of the AppIntegrations DataIntegration to use for ingesting content.
" + } + }, + "GetAssistantAssociationRequest": { + "base": null, + "refs": { + } + }, + "GetAssistantAssociationResponse": { + "base": null, + "refs": { + } + }, + "GetAssistantRequest": { + "base": null, + "refs": { + } + }, + "GetAssistantResponse": { + "base": null, + "refs": { + } + }, + "GetContentRequest": { + "base": null, + "refs": { + } + }, + "GetContentResponse": { + "base": null, + "refs": { + } + }, + "GetContentSummaryRequest": { + "base": null, + "refs": { + } + }, + "GetContentSummaryResponse": { + "base": null, + "refs": { + } + }, + "GetKnowledgeBaseRequest": { + "base": null, + "refs": { + } + }, + "GetKnowledgeBaseResponse": { + "base": null, + "refs": { + } + }, + "GetRecommendationsRequest": { + "base": null, + "refs": { + } + }, + "GetRecommendationsResponse": { + "base": null, + "refs": { + } + }, + "GetSessionRequest": { + "base": null, + "refs": { + } + }, + "GetSessionResponse": { + "base": null, + "refs": { + } + }, + "Headers": { + "base": null, + "refs": { + "StartContentUploadResponse$headersToInclude": "The headers to include in the upload.
" + } + }, + "Highlight": { + "base": "Offset specification to describe highlighting of document excerpts for rendering search results and recommendations.
", + "refs": { + "Highlights$member": null + } + }, + "HighlightOffset": { + "base": null, + "refs": { + "Highlight$beginOffsetInclusive": "The offset for the start of the highlight.
", + "Highlight$endOffsetExclusive": "The offset for the end of the highlight.
" + } + }, + "Highlights": { + "base": null, + "refs": { + "DocumentText$highlights": "Highlights in the document text.
" + } + }, + "KnowledgeBaseAssociationData": { + "base": "Association information about the knowledge base.
", + "refs": { + "AssistantAssociationOutputData$knowledgeBaseAssociation": "The knowledge base where output data is sent.
" + } + }, + "KnowledgeBaseData": { + "base": "Information about the knowledge base.
", + "refs": { + "CreateKnowledgeBaseResponse$knowledgeBase": "The knowledge base.
", + "GetKnowledgeBaseResponse$knowledgeBase": "The knowledge base.
", + "UpdateKnowledgeBaseTemplateUriResponse$knowledgeBase": "The knowledge base to update.
" + } + }, + "KnowledgeBaseList": { + "base": null, + "refs": { + "ListKnowledgeBasesResponse$knowledgeBaseSummaries": "Information about the knowledge bases.
" + } + }, + "KnowledgeBaseStatus": { + "base": null, + "refs": { + "KnowledgeBaseData$status": "The status of the knowledge base.
", + "KnowledgeBaseSummary$status": "The status of the knowledge base summary.
" + } + }, + "KnowledgeBaseSummary": { + "base": "Summary information about the knowledge base.
", + "refs": { + "KnowledgeBaseList$member": null + } + }, + "KnowledgeBaseType": { + "base": null, + "refs": { + "CreateKnowledgeBaseRequest$knowledgeBaseType": "The type of knowledge base. Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.
", + "KnowledgeBaseData$knowledgeBaseType": "The type of knowledge base.
", + "KnowledgeBaseSummary$knowledgeBaseType": "The type of knowledge base.
" + } + }, + "ListAssistantAssociationsRequest": { + "base": null, + "refs": { + } + }, + "ListAssistantAssociationsResponse": { + "base": null, + "refs": { + } + }, + "ListAssistantsRequest": { + "base": null, + "refs": { + } + }, + "ListAssistantsResponse": { + "base": null, + "refs": { + } + }, + "ListContentsRequest": { + "base": null, + "refs": { + } + }, + "ListContentsResponse": { + "base": null, + "refs": { + } + }, + "ListKnowledgeBasesRequest": { + "base": null, + "refs": { + } + }, + "ListKnowledgeBasesResponse": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceRequest": { + "base": null, + "refs": { + } + }, + "ListTagsForResourceResponse": { + "base": null, + "refs": { + } + }, + "MaxResults": { + "base": null, + "refs": { + "GetRecommendationsRequest$maxResults": "The maximum number of results to return per page.
", + "ListAssistantAssociationsRequest$maxResults": "The maximum number of results to return per page.
", + "ListAssistantsRequest$maxResults": "The maximum number of results to return per page.
", + "ListContentsRequest$maxResults": "The maximum number of results to return per page.
", + "ListKnowledgeBasesRequest$maxResults": "The maximum number of results to return per page.
", + "QueryAssistantRequest$maxResults": "The maximum number of results to return per page.
", + "SearchContentRequest$maxResults": "The maximum number of results to return per page.
", + "SearchSessionsRequest$maxResults": "The maximum number of results to return per page.
" + } + }, + "Name": { + "base": null, + "refs": { + "AssistantData$name": "The name.
", + "AssistantSummary$name": "The name of the assistant.
", + "ContentData$name": "The name of the content.
", + "ContentSummary$name": "The name of the content.
", + "CreateAssistantRequest$name": "The name of the assistant.
", + "CreateContentRequest$name": "The name of the content. Each piece of content in a knowledge base must have a unique name. You can retrieve a piece of content using only its knowledge base and its name with the SearchContent API.
", + "CreateKnowledgeBaseRequest$name": "The name of the knowledge base.
", + "CreateSessionRequest$name": "The name of the session.
", + "KnowledgeBaseData$name": "The name of the knowledge base.
", + "KnowledgeBaseSummary$name": "The name of the knowledge base.
", + "SessionData$name": "The name of the session.
" + } + }, + "NextToken": { + "base": null, + "refs": { + "ListAssistantAssociationsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListAssistantAssociationsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "ListAssistantsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListAssistantsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "ListContentsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListContentsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "QueryAssistantRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "QueryAssistantResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchContentRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "SearchContentResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "SearchSessionsRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "SearchSessionsResponse$nextToken": "If there are additional results, this is the token for the next set of results.
" + } + }, + "NonEmptyString": { + "base": null, + "refs": { + "ContentData$revisionId": "The identifier of the content revision.
", + "ContentMetadata$key": null, + "ContentMetadata$value": null, + "ContentSummary$revisionId": "The identifier of the revision of the content.
", + "CreateContentRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "CreateContentRequest$uploadId": "A pointer to the uploaded asset. This value is returned by StartContentUpload.
", + "CreateKnowledgeBaseRequest$clientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", + "Filter$value": "The desired field value on which to filter.
", + "Headers$key": null, + "Headers$value": null, + "ListKnowledgeBasesRequest$nextToken": "The token for the next set of results. Use the value returned in the previous response in the next request to retrieve the next set of results.
", + "ListKnowledgeBasesResponse$nextToken": "If there are additional results, this is the token for the next set of results.
", + "ObjectFieldsList$member": null, + "ServerSideEncryptionConfiguration$kmsKeyId": "The KMS key. For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide.
", + "StartContentUploadResponse$uploadId": "The identifier of the upload.
", + "UpdateContentRequest$revisionId": "The revisionId
of the content resource to update, taken from an earlier call to GetContent
, GetContentSummary
, SearchContent
, or ListContents
. If included, this argument acts as an optimistic lock to ensure content was not modified since it was last read. If it has been modified, this API throws a PreconditionFailedException
.
A pointer to the uploaded asset. This value is returned by StartContentUpload.
" + } + }, + "NotifyRecommendationsReceivedError": { + "base": "An error occurred when creating a recommendation.
", + "refs": { + "NotifyRecommendationsReceivedErrorList$member": null + } + }, + "NotifyRecommendationsReceivedErrorList": { + "base": null, + "refs": { + "NotifyRecommendationsReceivedResponse$errors": "The identifiers of recommendations that are causing errors.
" + } + }, + "NotifyRecommendationsReceivedErrorMessage": { + "base": null, + "refs": { + "NotifyRecommendationsReceivedError$message": "A recommendation is causing an error.
" + } + }, + "NotifyRecommendationsReceivedRequest": { + "base": null, + "refs": { + } + }, + "NotifyRecommendationsReceivedResponse": { + "base": null, + "refs": { + } + }, + "ObjectFieldsList": { + "base": null, + "refs": { + "AppIntegrationsConfiguration$objectFields": "The fields from the source that are made available to your agents in Wisdom.
For Salesforce, you must include at least Id
, ArticleNumber
, VersionNumber
, Title
, PublishStatus
, and IsDeleted
.
For ServiceNow, you must include at least number
, short_description
, sys_mod_count
, workflow_state
, and active
.
Make sure to include additional field(s); these are indexed and used to source recommendations.
" + } + }, + "PreconditionFailedException": { + "base": "The provided revisionId
does not match, indicating the content has been modified since it was last read.
The results of the query.
" + } + }, + "QueryText": { + "base": null, + "refs": { + "QueryAssistantRequest$queryText": "The text to search for.
" + } + }, + "RecommendationData": { + "base": "Information about the recommendation.
", + "refs": { + "RecommendationList$member": null + } + }, + "RecommendationIdList": { + "base": null, + "refs": { + "NotifyRecommendationsReceivedRequest$recommendationIds": "The identifiers of the recommendations.
", + "NotifyRecommendationsReceivedResponse$recommendationIds": "The identifiers of the recommendations.
" + } + }, + "RecommendationList": { + "base": null, + "refs": { + "GetRecommendationsResponse$recommendations": "The recommendations.
" + } + }, + "RelevanceLevel": { + "base": null, + "refs": { + "RecommendationData$relevanceLevel": "The relevance level of the recommendation.
" + } + }, + "RelevanceScore": { + "base": null, + "refs": { + "RecommendationData$relevanceScore": "The relevance score of the recommendation.
", + "ResultData$relevanceScore": "The relevance score of the results.
" + } + }, + "RemoveKnowledgeBaseTemplateUriRequest": { + "base": null, + "refs": { + } + }, + "RemoveKnowledgeBaseTemplateUriResponse": { + "base": null, + "refs": { + } + }, + "RenderingConfiguration": { + "base": "Information about how to render the content.
", + "refs": { + "CreateKnowledgeBaseRequest$renderingConfiguration": "Information about how to render the content.
", + "KnowledgeBaseData$renderingConfiguration": "Information about how to render the content.
", + "KnowledgeBaseSummary$renderingConfiguration": "Information about how to render the content.
" + } + }, + "ResourceNotFoundException": { + "base": "The specified resource does not exist.
", + "refs": { + } + }, + "ResultData": { + "base": "Information about the result.
", + "refs": { + "QueryResultsList$member": null + } + }, + "SearchContentRequest": { + "base": null, + "refs": { + } + }, + "SearchContentResponse": { + "base": null, + "refs": { + } + }, + "SearchExpression": { + "base": "The search expression.
", + "refs": { + "SearchContentRequest$searchExpression": "The search expression to filter results.
", + "SearchSessionsRequest$searchExpression": "The search expression to filter results.
" + } + }, + "SearchSessionsRequest": { + "base": null, + "refs": { + } + }, + "SearchSessionsResponse": { + "base": null, + "refs": { + } + }, + "ServerSideEncryptionConfiguration": { + "base": "The KMS key used for encryption.
", + "refs": { + "AssistantData$serverSideEncryptionConfiguration": "The KMS key used for encryption.
", + "AssistantSummary$serverSideEncryptionConfiguration": "The KMS key used for encryption.
", + "CreateAssistantRequest$serverSideEncryptionConfiguration": "The KMS key used for encryption.
", + "CreateKnowledgeBaseRequest$serverSideEncryptionConfiguration": "The KMS key used for encryption.
", + "KnowledgeBaseData$serverSideEncryptionConfiguration": "The KMS key used for encryption.
", + "KnowledgeBaseSummary$serverSideEncryptionConfiguration": "The KMS key used for encryption.
" + } + }, + "ServiceQuotaExceededException": { + "base": "You've exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use service quotas to request a service quota increase.
", + "refs": { + } + }, + "SessionData": { + "base": "Information about the session.
", + "refs": { + "CreateSessionResponse$session": "The session.
", + "GetSessionResponse$session": "The session.
" + } + }, + "SessionSummaries": { + "base": null, + "refs": { + "SearchSessionsResponse$sessionSummaries": "Summary information about the sessions.
" + } + }, + "SessionSummary": { + "base": "Summary information about the session.
", + "refs": { + "SessionSummaries$member": null + } + }, + "SourceConfiguration": { + "base": "Configuration information about the external data source.
", + "refs": { + "CreateKnowledgeBaseRequest$sourceConfiguration": "The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.
", + "KnowledgeBaseData$sourceConfiguration": "Source configuration information about the knowledge base.
", + "KnowledgeBaseSummary$sourceConfiguration": "[KEVIN]
" + } + }, + "StartContentUploadRequest": { + "base": null, + "refs": { + } + }, + "StartContentUploadResponse": { + "base": null, + "refs": { + } + }, + "String": { + "base": null, + "refs": { + "AccessDeniedException$message": null, + "ConflictException$message": null, + "NotifyRecommendationsReceivedError$recommendationId": "The identifier of the recommendation that is in error.
", + "PreconditionFailedException$message": null, + "RecommendationData$recommendationId": "The identifier of the recommendation.
", + "RecommendationIdList$member": null, + "ResourceNotFoundException$message": null, + "ResourceNotFoundException$resourceName": "The specified resource name.
", + "ServiceQuotaExceededException$message": null, + "TooManyTagsException$message": null, + "TooManyTagsException$resourceName": "The specified resource name.
", + "ValidationException$message": null + } + }, + "SyntheticContentDataUrl": { + "base": null, + "refs": { + "ContentData$url": "The URL of the content.
" + } + }, + "SyntheticDocumentTextString": { + "base": null, + "refs": { + "DocumentText$text": "Text in the document.
" + } + }, + "SyntheticStartContentUploadResponseUrl": { + "base": null, + "refs": { + "StartContentUploadResponse$url": "The URL of the upload.
" + } + }, + "SyntheticTimestamp_epoch_seconds": { + "base": null, + "refs": { + "ContentData$urlExpiry": "The expiration time of the URL as an epoch timestamp.
", + "KnowledgeBaseData$lastContentModificationTime": "An epoch timestamp indicating the most recent content modification inside the knowledge base. If no content exists in a knowledge base, this value is unset.
", + "StartContentUploadResponse$urlExpiry": "The expiration time of the URL as an epoch timestamp.
" + } + }, + "TagKey": { + "base": null, + "refs": { + "TagKeyList$member": null, + "Tags$key": null + } + }, + "TagKeyList": { + "base": null, + "refs": { + "UntagResourceRequest$tagKeys": "The tag keys.
" + } + }, + "TagResourceRequest": { + "base": null, + "refs": { + } + }, + "TagResourceResponse": { + "base": null, + "refs": { + } + }, + "TagValue": { + "base": null, + "refs": { + "Tags$value": null + } + }, + "Tags": { + "base": null, + "refs": { + "AssistantAssociationData$tags": "The tags used to organize, track, or control access for this resource.
", + "AssistantAssociationSummary$tags": "The tags used to organize, track, or control access for this resource.
", + "AssistantData$tags": "The tags used to organize, track, or control access for this resource.
", + "AssistantSummary$tags": "The tags used to organize, track, or control access for this resource.
", + "ContentData$tags": "The tags used to organize, track, or control access for this resource.
", + "ContentSummary$tags": "The tags used to organize, track, or control access for this resource.
", + "CreateAssistantAssociationRequest$tags": "The tags used to organize, track, or control access for this resource.
", + "CreateAssistantRequest$tags": "The tags used to organize, track, or control access for this resource.
", + "CreateContentRequest$tags": "The tags used to organize, track, or control access for this resource.
", + "CreateKnowledgeBaseRequest$tags": "The tags used to organize, track, or control access for this resource.
", + "CreateSessionRequest$tags": "The tags used to organize, track, or control access for this resource.
", + "KnowledgeBaseData$tags": "The tags used to organize, track, or control access for this resource.
", + "KnowledgeBaseSummary$tags": "The tags used to organize, track, or control access for this resource.
", + "ListTagsForResourceResponse$tags": "The tags used to organize, track, or control access for this resource.
", + "SessionData$tags": "The tags used to organize, track, or control access for this resource.
", + "TagResourceRequest$tags": "The tags used to organize, track, or control access for this resource.
" + } + }, + "TooManyTagsException": { + "base": "Amazon Connect Wisdom throws this exception if you have too many tags in your tag set.
", + "refs": { + } + }, + "UntagResourceRequest": { + "base": null, + "refs": { + } + }, + "UntagResourceResponse": { + "base": null, + "refs": { + } + }, + "UpdateContentRequest": { + "base": null, + "refs": { + } + }, + "UpdateContentResponse": { + "base": null, + "refs": { + } + }, + "UpdateKnowledgeBaseTemplateUriRequest": { + "base": null, + "refs": { + } + }, + "UpdateKnowledgeBaseTemplateUriResponse": { + "base": null, + "refs": { + } + }, + "Uri": { + "base": null, + "refs": { + "ContentData$linkOutUri": "The URI of the content.
", + "CreateContentRequest$overrideLinkOutUri": "The URI you want to use for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content.
", + "RenderingConfiguration$templateUri": "A URI template containing exactly one variable in ${variableName}
format. This can only be set for EXTERNAL
knowledge bases. For Salesforce and ServiceNow, the variable must be one of the following:
Salesforce: Id
, ArticleNumber
, VersionNumber
, Title
, PublishStatus
, or IsDeleted
ServiceNow: number
, short_description
, sys_mod_count
, workflow_state
, or active
<p>The variable is replaced with the actual value for a piece of content when calling <a href="https://docs.aws.amazon.com/wisdom/latest/APIReference/API_GetContent.html">GetContent</a>. </p>
",
+ "UpdateContentRequest$overrideLinkOutUri": "The URI for the article. If the knowledge base has a templateUri, setting this argument overrides it for this piece of content. To remove an existing overrideLinkOurUri
, exclude this argument and set removeOverrideLinkOutUri
to true.
The template URI to update.
" + } + }, + "Uuid": { + "base": null, + "refs": { + "AssistantAssociationData$assistantAssociationId": "The identifier of the assistant association.
", + "AssistantAssociationData$assistantId": "The identifier of the Wisdom assistant.
", + "AssistantAssociationInputData$knowledgeBaseId": "The the identifier of the knowledge base.
", + "AssistantAssociationSummary$assistantAssociationId": "The identifier of the assistant association.
", + "AssistantAssociationSummary$assistantId": "The identifier of the Wisdom assistant.
", + "AssistantData$assistantId": "The identifier of the Wisdom assistant.
", + "AssistantSummary$assistantId": "The identifier of the Wisdom assistant.
", + "ContentData$contentId": "The identifier of the content.
", + "ContentData$knowledgeBaseId": "The the identifier of the knowledge base.
", + "ContentReference$contentId": "The identifier of the content.
", + "ContentReference$knowledgeBaseId": "The the identifier of the knowledge base.
", + "ContentSummary$contentId": "The identifier of the content.
", + "ContentSummary$knowledgeBaseId": "The the identifier of the knowledge base.
", + "KnowledgeBaseAssociationData$knowledgeBaseId": "The the identifier of the knowledge base.
", + "KnowledgeBaseData$knowledgeBaseId": "The the identifier of the knowledge base.
", + "KnowledgeBaseSummary$knowledgeBaseId": "The the identifier of the knowledge base.
", + "ResultData$resultId": "The identifier of the result data.
", + "SessionData$sessionId": "The identifier of the session.
", + "SessionSummary$assistantId": "The identifier of the Wisdom assistant.
", + "SessionSummary$sessionId": "The identifier of the session.
" + } + }, + "UuidOrArn": { + "base": null, + "refs": { + "CreateAssistantAssociationRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "CreateContentRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "CreateSessionRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteAssistantAssociationRequest$assistantAssociationId": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteAssistantAssociationRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteAssistantRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteContentRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "DeleteKnowledgeBaseRequest$knowledgeBaseId": "The knowledge base to delete content from. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetAssistantAssociationRequest$assistantAssociationId": "The identifier of the assistant association. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetAssistantAssociationRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetAssistantRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetContentRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetContentSummaryRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetContentSummaryRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetKnowledgeBaseRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetRecommendationsRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetRecommendationsRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetSessionRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "GetSessionRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "ListAssistantAssociationsRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "ListContentsRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "NotifyRecommendationsReceivedRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "NotifyRecommendationsReceivedRequest$sessionId": "The identifier of the session. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "QueryAssistantRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "RemoveKnowledgeBaseTemplateUriRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "SearchContentRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "SearchSessionsRequest$assistantId": "The identifier of the Wisdom assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "StartContentUploadRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "UpdateContentRequest$contentId": "The identifier of the content. Can be either the ID or the ARN. URLs cannot contain the ARN.
", + "UpdateContentRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN
", + "UpdateKnowledgeBaseTemplateUriRequest$knowledgeBaseId": "The the identifier of the knowledge base. Can be either the ID or the ARN. URLs cannot contain the ARN.
" + } + }, + "ValidationException": { + "base": "The input fails to satisfy the constraints specified by an AWS service.
", + "refs": { + } + }, + "WaitTimeSeconds": { + "base": null, + "refs": { + "GetRecommendationsRequest$waitTimeSeconds": "The duration (in seconds) for which the call waits for a recommendation to be made available before returning. If a recommendation is available, the call returns sooner than WaitTimeSeconds
. If no messages are available and the wait time expires, the call returns successfully with an empty list.
For example, you're programmatically managing your external knowledge +// base, and you want to add or remove one of the fields that is being ingested +// from Salesforce. Do the following:
Call DeleteKnowledgeBase.
+//Call DeleteDataIntegration.
+//Call CreateDataIntegration +// to recreate the DataIntegration or a create different one.
Call CreateKnowledgeBase.
The variable is replaced with the actual value for a piece of content + // when calling GetContent. + //
+ TemplateUri *string `locationName:"templateUri" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RenderingConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RenderingConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RenderingConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RenderingConfiguration"} + if s.TemplateUri != nil && len(*s.TemplateUri) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateUri", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetTemplateUri sets the TemplateUri field's value. +func (s *RenderingConfiguration) SetTemplateUri(v string) *RenderingConfiguration { + s.TemplateUri = &v + return s +} + +// The specified resource does not exist. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The specified resource name. + ResourceName *string `locationName:"resourceName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Information about the result. +type ResultData struct { + _ struct{} `type:"structure"` + + // The document. + // + // Document is a required field + Document *Document `locationName:"document" type:"structure" required:"true"` + + // The relevance score of the results. + RelevanceScore *float64 `locationName:"relevanceScore" type:"double"` + + // The identifier of the result data. + // + // ResultId is a required field + ResultId *string `locationName:"resultId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResultData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResultData) GoString() string { + return s.String() +} + +// SetDocument sets the Document field's value. +func (s *ResultData) SetDocument(v *Document) *ResultData { + s.Document = v + return s +} + +// SetRelevanceScore sets the RelevanceScore field's value. +func (s *ResultData) SetRelevanceScore(v float64) *ResultData { + s.RelevanceScore = &v + return s +} + +// SetResultId sets the ResultId field's value. +func (s *ResultData) SetResultId(v string) *ResultData { + s.ResultId = &v + return s +} + +type SearchContentInput struct { + _ struct{} `type:"structure"` + + // The the identifier of the knowledge base. Can be either the ID or the ARN. + // URLs cannot contain the ARN. + // + // KnowledgeBaseId is a required field + KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The search expression to filter results. + // + // SearchExpression is a required field + SearchExpression *SearchExpression `locationName:"searchExpression" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchContentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchContentInput"} + if s.KnowledgeBaseId == nil { + invalidParams.Add(request.NewErrParamRequired("KnowledgeBaseId")) + } + if s.KnowledgeBaseId != nil && len(*s.KnowledgeBaseId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KnowledgeBaseId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.SearchExpression == nil { + invalidParams.Add(request.NewErrParamRequired("SearchExpression")) + } + if s.SearchExpression != nil { + if err := s.SearchExpression.Validate(); err != nil { + invalidParams.AddNested("SearchExpression", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKnowledgeBaseId sets the KnowledgeBaseId field's value. +func (s *SearchContentInput) SetKnowledgeBaseId(v string) *SearchContentInput { + s.KnowledgeBaseId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchContentInput) SetMaxResults(v int64) *SearchContentInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContentInput) SetNextToken(v string) *SearchContentInput { + s.NextToken = &v + return s +} + +// SetSearchExpression sets the SearchExpression field's value. +func (s *SearchContentInput) SetSearchExpression(v *SearchExpression) *SearchContentInput { + s.SearchExpression = v + return s +} + +type SearchContentOutput struct { + _ struct{} `type:"structure"` + + // Summary information about the content. + // + // ContentSummaries is a required field + ContentSummaries []*ContentSummary `locationName:"contentSummaries" type:"list" required:"true"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchContentOutput) GoString() string { + return s.String() +} + +// SetContentSummaries sets the ContentSummaries field's value. +func (s *SearchContentOutput) SetContentSummaries(v []*ContentSummary) *SearchContentOutput { + s.ContentSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchContentOutput) SetNextToken(v string) *SearchContentOutput { + s.NextToken = &v + return s +} + +// The search expression. +type SearchExpression struct { + _ struct{} `type:"structure"` + + // The search expression filters. + // + // Filters is a required field + Filters []*Filter `locationName:"filters" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchExpression) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchExpression) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchExpression) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchExpression"} + if s.Filters == nil { + invalidParams.Add(request.NewErrParamRequired("Filters")) + } + if s.Filters != nil { + for i, v := range s.Filters { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Filters", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilters sets the Filters field's value. +func (s *SearchExpression) SetFilters(v []*Filter) *SearchExpression { + s.Filters = v + return s +} + +type SearchSessionsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the Wisdom assistant. Can be either the ID or the ARN. + // URLs cannot contain the ARN. + // + // AssistantId is a required field + AssistantId *string `location:"uri" locationName:"assistantId" type:"string" required:"true"` + + // The maximum number of results to return per page. + MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"` + + // The token for the next set of results. Use the value returned in the previous + // response in the next request to retrieve the next set of results. + NextToken *string `location:"querystring" locationName:"nextToken" min:"1" type:"string"` + + // The search expression to filter results. + // + // SearchExpression is a required field + SearchExpression *SearchExpression `locationName:"searchExpression" type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSessionsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSessionsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SearchSessionsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SearchSessionsInput"} + if s.AssistantId == nil { + invalidParams.Add(request.NewErrParamRequired("AssistantId")) + } + if s.AssistantId != nil && len(*s.AssistantId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("AssistantId", 1)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + if s.NextToken != nil && len(*s.NextToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("NextToken", 1)) + } + if s.SearchExpression == nil { + invalidParams.Add(request.NewErrParamRequired("SearchExpression")) + } + if s.SearchExpression != nil { + if err := s.SearchExpression.Validate(); err != nil { + invalidParams.AddNested("SearchExpression", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAssistantId sets the AssistantId field's value. +func (s *SearchSessionsInput) SetAssistantId(v string) *SearchSessionsInput { + s.AssistantId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *SearchSessionsInput) SetMaxResults(v int64) *SearchSessionsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchSessionsInput) SetNextToken(v string) *SearchSessionsInput { + s.NextToken = &v + return s +} + +// SetSearchExpression sets the SearchExpression field's value. +func (s *SearchSessionsInput) SetSearchExpression(v *SearchExpression) *SearchSessionsInput { + s.SearchExpression = v + return s +} + +type SearchSessionsOutput struct { + _ struct{} `type:"structure"` + + // If there are additional results, this is the token for the next set of results. + NextToken *string `locationName:"nextToken" min:"1" type:"string"` + + // Summary information about the sessions. + // + // SessionSummaries is a required field + SessionSummaries []*SessionSummary `locationName:"sessionSummaries" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSessionsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SearchSessionsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *SearchSessionsOutput) SetNextToken(v string) *SearchSessionsOutput { + s.NextToken = &v + return s +} + +// SetSessionSummaries sets the SessionSummaries field's value. +func (s *SearchSessionsOutput) SetSessionSummaries(v []*SessionSummary) *SearchSessionsOutput { + s.SessionSummaries = v + return s +} + +// The KMS key used for encryption. +type ServerSideEncryptionConfiguration struct { + _ struct{} `type:"structure"` + + // The KMS key. For information about valid ID values, see Key identifiers (KeyId) + // (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) + // in the AWS Key Management Service Developer Guide. + KmsKeyId *string `locationName:"kmsKeyId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerSideEncryptionConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerSideEncryptionConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerSideEncryptionConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerSideEncryptionConfiguration"} + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *ServerSideEncryptionConfiguration) SetKmsKeyId(v string) *ServerSideEncryptionConfiguration { + s.KmsKeyId = &v + return s +} + +// You've exceeded your service quota. To perform the requested action, remove +// some of the relevant resources, or use service quotas to request a service +// quota increase. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Information about the session. +type SessionData struct { + _ struct{} `type:"structure"` + + // The description of the session. + Description *string `locationName:"description" min:"1" type:"string"` + + // The name of the session. + // + // Name is a required field + Name *string `locationName:"name" min:"1" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the session. + // + // SessionArn is a required field + SessionArn *string `locationName:"sessionArn" type:"string" required:"true"` + + // The identifier of the session. + // + // SessionId is a required field + SessionId *string `locationName:"sessionId" type:"string" required:"true"` + + // The tags used to organize, track, or control access for this resource. + Tags map[string]*string `locationName:"tags" type:"map"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SessionData) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SessionData) GoString() string { + return s.String() +} + +// SetDescription sets the Description field's value. +func (s *SessionData) SetDescription(v string) *SessionData { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *SessionData) SetName(v string) *SessionData { + s.Name = &v + return s +} + +// SetSessionArn sets the SessionArn field's value. +func (s *SessionData) SetSessionArn(v string) *SessionData { + s.SessionArn = &v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *SessionData) SetSessionId(v string) *SessionData { + s.SessionId = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *SessionData) SetTags(v map[string]*string) *SessionData { + s.Tags = v + return s +} + +// Summary information about the session. +type SessionSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Wisdom assistant + // + // AssistantArn is a required field + AssistantArn *string `locationName:"assistantArn" type:"string" required:"true"` + + // The identifier of the Wisdom assistant. + // + // AssistantId is a required field + AssistantId *string `locationName:"assistantId" type:"string" required:"true"` + + // The Amazon Resource Name (ARN) of the session. + // + // SessionArn is a required field + SessionArn *string `locationName:"sessionArn" type:"string" required:"true"` + + // The identifier of the session. + // + // SessionId is a required field + SessionId *string `locationName:"sessionId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SessionSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SessionSummary) GoString() string { + return s.String() +} + +// SetAssistantArn sets the AssistantArn field's value. +func (s *SessionSummary) SetAssistantArn(v string) *SessionSummary { + s.AssistantArn = &v + return s +} + +// SetAssistantId sets the AssistantId field's value. +func (s *SessionSummary) SetAssistantId(v string) *SessionSummary { + s.AssistantId = &v + return s +} + +// SetSessionArn sets the SessionArn field's value. +func (s *SessionSummary) SetSessionArn(v string) *SessionSummary { + s.SessionArn = &v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *SessionSummary) SetSessionId(v string) *SessionSummary { + s.SessionId = &v + return s +} + +// Configuration information about the external data source. +type SourceConfiguration struct { + _ struct{} `type:"structure"` + + // Configuration information for Amazon AppIntegrations to automatically ingest + // content. + AppIntegrations *AppIntegrationsConfiguration `locationName:"appIntegrations" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SourceConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SourceConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *SourceConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "SourceConfiguration"} + if s.AppIntegrations != nil { + if err := s.AppIntegrations.Validate(); err != nil { + invalidParams.AddNested("AppIntegrations", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetAppIntegrations sets the AppIntegrations field's value. +func (s *SourceConfiguration) SetAppIntegrations(v *AppIntegrationsConfiguration) *SourceConfiguration { + s.AppIntegrations = v + return s +} + +type StartContentUploadInput struct { + _ struct{} `type:"structure"` + + // The type of content to upload. + // + // ContentType is a required field + ContentType *string `locationName:"contentType" type:"string" required:"true"` + + // The the identifier of the knowledge base. Can be either the ID or the ARN. + // URLs cannot contain the ARN. + // + // KnowledgeBaseId is a required field + KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartContentUploadInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartContentUploadInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartContentUploadInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartContentUploadInput"} + if s.ContentType == nil { + invalidParams.Add(request.NewErrParamRequired("ContentType")) + } + if s.KnowledgeBaseId == nil { + invalidParams.Add(request.NewErrParamRequired("KnowledgeBaseId")) + } + if s.KnowledgeBaseId != nil && len(*s.KnowledgeBaseId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KnowledgeBaseId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContentType sets the ContentType field's value. +func (s *StartContentUploadInput) SetContentType(v string) *StartContentUploadInput { + s.ContentType = &v + return s +} + +// SetKnowledgeBaseId sets the KnowledgeBaseId field's value. +func (s *StartContentUploadInput) SetKnowledgeBaseId(v string) *StartContentUploadInput { + s.KnowledgeBaseId = &v + return s +} + +type StartContentUploadOutput struct { + _ struct{} `type:"structure"` + + // The headers to include in the upload. + // + // HeadersToInclude is a required field + HeadersToInclude map[string]*string `locationName:"headersToInclude" type:"map" required:"true"` + + // The identifier of the upload. + // + // UploadId is a required field + UploadId *string `locationName:"uploadId" min:"1" type:"string" required:"true"` + + // The URL of the upload. + // + // Url is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartContentUploadOutput's + // String and GoString methods. + // + // Url is a required field + Url *string `locationName:"url" min:"1" type:"string" required:"true" sensitive:"true"` + + // The expiration time of the URL as an epoch timestamp. + // + // UrlExpiry is a required field + UrlExpiry *time.Time `locationName:"urlExpiry" type:"timestamp" timestampFormat:"unixTimestamp" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartContentUploadOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartContentUploadOutput) GoString() string { + return s.String() +} + +// SetHeadersToInclude sets the HeadersToInclude field's value. +func (s *StartContentUploadOutput) SetHeadersToInclude(v map[string]*string) *StartContentUploadOutput { + s.HeadersToInclude = v + return s +} + +// SetUploadId sets the UploadId field's value. +func (s *StartContentUploadOutput) SetUploadId(v string) *StartContentUploadOutput { + s.UploadId = &v + return s +} + +// SetUrl sets the Url field's value. +func (s *StartContentUploadOutput) SetUrl(v string) *StartContentUploadOutput { + s.Url = &v + return s +} + +// SetUrlExpiry sets the UrlExpiry field's value. +func (s *StartContentUploadOutput) SetUrlExpiry(v time.Time) *StartContentUploadOutput { + s.UrlExpiry = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // The tags used to organize, track, or control access for this resource. + // + // Tags is a required field + Tags map[string]*string `locationName:"tags" type:"map" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// Amazon Connect Wisdom throws this exception if you have too many tags in +// your tag set. +type TooManyTagsException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` + + // The specified resource name. + ResourceName *string `locationName:"resourceName" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TooManyTagsException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TooManyTagsException) GoString() string { + return s.String() +} + +func newErrorTooManyTagsException(v protocol.ResponseMetadata) error { + return &TooManyTagsException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *TooManyTagsException) Code() string { + return "TooManyTagsException" +} + +// Message returns the exception's message. +func (s *TooManyTagsException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *TooManyTagsException) OrigErr() error { + return nil +} + +func (s *TooManyTagsException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *TooManyTagsException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *TooManyTagsException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the resource. + // + // ResourceArn is a required field + ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"` + + // The tag keys. + // + // TagKeys is a required field + TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + if s.TagKeys != nil && len(s.TagKeys) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TagKeys", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateContentInput struct { + _ struct{} `type:"structure"` + + // The identifier of the content. Can be either the ID or the ARN. URLs cannot + // contain the ARN. + // + // ContentId is a required field + ContentId *string `location:"uri" locationName:"contentId" type:"string" required:"true"` + + // The the identifier of the knowledge base. Can be either the ID or the ARN + // + // KnowledgeBaseId is a required field + KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` + + // A key/value map to store attributes without affecting tagging or recommendations. + // For example, when synchronizing data between an external system and Wisdom, + // you can store an external version identifier as metadata to utilize for determining + // drift. + Metadata map[string]*string `locationName:"metadata" type:"map"` + + // The URI for the article. If the knowledge base has a templateUri, setting + // this argument overrides it for this piece of content. To remove an existing + // overrideLinkOurUri, exclude this argument and set removeOverrideLinkOutUri + // to true. + OverrideLinkOutUri *string `locationName:"overrideLinkOutUri" min:"1" type:"string"` + + // Unset the existing overrideLinkOutUri if it exists. + RemoveOverrideLinkOutUri *bool `locationName:"removeOverrideLinkOutUri" type:"boolean"` + + // The revisionId of the content resource to update, taken from an earlier call + // to GetContent, GetContentSummary, SearchContent, or ListContents. If included, + // this argument acts as an optimistic lock to ensure content was not modified + // since it was last read. If it has been modified, this API throws a PreconditionFailedException. + RevisionId *string `locationName:"revisionId" min:"1" type:"string"` + + // The title of the content. + Title *string `locationName:"title" min:"1" type:"string"` + + // A pointer to the uploaded asset. This value is returned by StartContentUpload + // (https://docs.aws.amazon.com/wisdom/latest/APIReference/API_StartContentUpload.html). + UploadId *string `locationName:"uploadId" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateContentInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateContentInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateContentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateContentInput"} + if s.ContentId == nil { + invalidParams.Add(request.NewErrParamRequired("ContentId")) + } + if s.ContentId != nil && len(*s.ContentId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ContentId", 1)) + } + if s.KnowledgeBaseId == nil { + invalidParams.Add(request.NewErrParamRequired("KnowledgeBaseId")) + } + if s.KnowledgeBaseId != nil && len(*s.KnowledgeBaseId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KnowledgeBaseId", 1)) + } + if s.OverrideLinkOutUri != nil && len(*s.OverrideLinkOutUri) < 1 { + invalidParams.Add(request.NewErrParamMinLen("OverrideLinkOutUri", 1)) + } + if s.RevisionId != nil && len(*s.RevisionId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("RevisionId", 1)) + } + if s.Title != nil && len(*s.Title) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Title", 1)) + } + if s.UploadId != nil && len(*s.UploadId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("UploadId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetContentId sets the ContentId field's value. +func (s *UpdateContentInput) SetContentId(v string) *UpdateContentInput { + s.ContentId = &v + return s +} + +// SetKnowledgeBaseId sets the KnowledgeBaseId field's value. +func (s *UpdateContentInput) SetKnowledgeBaseId(v string) *UpdateContentInput { + s.KnowledgeBaseId = &v + return s +} + +// SetMetadata sets the Metadata field's value. +func (s *UpdateContentInput) SetMetadata(v map[string]*string) *UpdateContentInput { + s.Metadata = v + return s +} + +// SetOverrideLinkOutUri sets the OverrideLinkOutUri field's value. +func (s *UpdateContentInput) SetOverrideLinkOutUri(v string) *UpdateContentInput { + s.OverrideLinkOutUri = &v + return s +} + +// SetRemoveOverrideLinkOutUri sets the RemoveOverrideLinkOutUri field's value. +func (s *UpdateContentInput) SetRemoveOverrideLinkOutUri(v bool) *UpdateContentInput { + s.RemoveOverrideLinkOutUri = &v + return s +} + +// SetRevisionId sets the RevisionId field's value. +func (s *UpdateContentInput) SetRevisionId(v string) *UpdateContentInput { + s.RevisionId = &v + return s +} + +// SetTitle sets the Title field's value. +func (s *UpdateContentInput) SetTitle(v string) *UpdateContentInput { + s.Title = &v + return s +} + +// SetUploadId sets the UploadId field's value. +func (s *UpdateContentInput) SetUploadId(v string) *UpdateContentInput { + s.UploadId = &v + return s +} + +type UpdateContentOutput struct { + _ struct{} `type:"structure"` + + // The content. + Content *ContentData `locationName:"content" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateContentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateContentOutput) GoString() string { + return s.String() +} + +// SetContent sets the Content field's value. +func (s *UpdateContentOutput) SetContent(v *ContentData) *UpdateContentOutput { + s.Content = v + return s +} + +type UpdateKnowledgeBaseTemplateUriInput struct { + _ struct{} `type:"structure"` + + // The the identifier of the knowledge base. Can be either the ID or the ARN. + // URLs cannot contain the ARN. + // + // KnowledgeBaseId is a required field + KnowledgeBaseId *string `location:"uri" locationName:"knowledgeBaseId" type:"string" required:"true"` + + // The template URI to update. + // + // TemplateUri is a required field + TemplateUri *string `locationName:"templateUri" min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateKnowledgeBaseTemplateUriInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateKnowledgeBaseTemplateUriInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateKnowledgeBaseTemplateUriInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateKnowledgeBaseTemplateUriInput"} + if s.KnowledgeBaseId == nil { + invalidParams.Add(request.NewErrParamRequired("KnowledgeBaseId")) + } + if s.KnowledgeBaseId != nil && len(*s.KnowledgeBaseId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KnowledgeBaseId", 1)) + } + if s.TemplateUri == nil { + invalidParams.Add(request.NewErrParamRequired("TemplateUri")) + } + if s.TemplateUri != nil && len(*s.TemplateUri) < 1 { + invalidParams.Add(request.NewErrParamMinLen("TemplateUri", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKnowledgeBaseId sets the KnowledgeBaseId field's value. +func (s *UpdateKnowledgeBaseTemplateUriInput) SetKnowledgeBaseId(v string) *UpdateKnowledgeBaseTemplateUriInput { + s.KnowledgeBaseId = &v + return s +} + +// SetTemplateUri sets the TemplateUri field's value. +func (s *UpdateKnowledgeBaseTemplateUriInput) SetTemplateUri(v string) *UpdateKnowledgeBaseTemplateUriInput { + s.TemplateUri = &v + return s +} + +type UpdateKnowledgeBaseTemplateUriOutput struct { + _ struct{} `type:"structure"` + + // The knowledge base to update. + KnowledgeBase *KnowledgeBaseData `locationName:"knowledgeBase" type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateKnowledgeBaseTemplateUriOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateKnowledgeBaseTemplateUriOutput) GoString() string { + return s.String() +} + +// SetKnowledgeBase sets the KnowledgeBase field's value. +func (s *UpdateKnowledgeBaseTemplateUriOutput) SetKnowledgeBase(v *KnowledgeBaseData) *UpdateKnowledgeBaseTemplateUriOutput { + s.KnowledgeBase = v + return s +} + +// The input fails to satisfy the constraints specified by an AWS service. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"message" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +const ( + // AssistantStatusCreateInProgress is a AssistantStatus enum value + AssistantStatusCreateInProgress = "CREATE_IN_PROGRESS" + + // AssistantStatusCreateFailed is a AssistantStatus enum value + AssistantStatusCreateFailed = "CREATE_FAILED" + + // AssistantStatusActive is a AssistantStatus enum value + AssistantStatusActive = "ACTIVE" + + // AssistantStatusDeleteInProgress is a AssistantStatus enum value + AssistantStatusDeleteInProgress = "DELETE_IN_PROGRESS" + + // AssistantStatusDeleteFailed is a AssistantStatus enum value + AssistantStatusDeleteFailed = "DELETE_FAILED" + + // AssistantStatusDeleted is a AssistantStatus enum value + AssistantStatusDeleted = "DELETED" +) + +// AssistantStatus_Values returns all elements of the AssistantStatus enum +func AssistantStatus_Values() []string { + return []string{ + AssistantStatusCreateInProgress, + AssistantStatusCreateFailed, + AssistantStatusActive, + AssistantStatusDeleteInProgress, + AssistantStatusDeleteFailed, + AssistantStatusDeleted, + } +} + +const ( + // AssistantTypeAgent is a AssistantType enum value + AssistantTypeAgent = "AGENT" +) + +// AssistantType_Values returns all elements of the AssistantType enum +func AssistantType_Values() []string { + return []string{ + AssistantTypeAgent, + } +} + +const ( + // AssociationTypeKnowledgeBase is a AssociationType enum value + AssociationTypeKnowledgeBase = "KNOWLEDGE_BASE" +) + +// AssociationType_Values returns all elements of the AssociationType enum +func AssociationType_Values() []string { + return []string{ + AssociationTypeKnowledgeBase, + } +} + +const ( + // ContentStatusCreateInProgress is a ContentStatus enum value + ContentStatusCreateInProgress = "CREATE_IN_PROGRESS" + + // ContentStatusCreateFailed is a ContentStatus enum value + ContentStatusCreateFailed = "CREATE_FAILED" + + // ContentStatusActive is a ContentStatus enum value + ContentStatusActive = "ACTIVE" + + // ContentStatusDeleteInProgress is a ContentStatus enum value + ContentStatusDeleteInProgress = "DELETE_IN_PROGRESS" + + // ContentStatusDeleteFailed is a ContentStatus enum value + ContentStatusDeleteFailed = "DELETE_FAILED" + + // ContentStatusDeleted is a ContentStatus enum value + ContentStatusDeleted = "DELETED" + + // ContentStatusUpdateFailed is a ContentStatus enum value + ContentStatusUpdateFailed = "UPDATE_FAILED" +) + +// ContentStatus_Values returns all elements of the ContentStatus enum +func ContentStatus_Values() []string { + return []string{ + ContentStatusCreateInProgress, + ContentStatusCreateFailed, + ContentStatusActive, + ContentStatusDeleteInProgress, + ContentStatusDeleteFailed, + ContentStatusDeleted, + ContentStatusUpdateFailed, + } +} + +const ( + // FilterFieldName is a FilterField enum value + FilterFieldName = "NAME" +) + +// FilterField_Values returns all elements of the FilterField enum +func FilterField_Values() []string { + return []string{ + FilterFieldName, + } +} + +const ( + // FilterOperatorEquals is a FilterOperator enum value + FilterOperatorEquals = "EQUALS" +) + +// FilterOperator_Values returns all elements of the FilterOperator enum +func FilterOperator_Values() []string { + return []string{ + FilterOperatorEquals, + } +} + +const ( + // KnowledgeBaseStatusCreateInProgress is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusCreateInProgress = "CREATE_IN_PROGRESS" + + // KnowledgeBaseStatusCreateFailed is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusCreateFailed = "CREATE_FAILED" + + // KnowledgeBaseStatusActive is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusActive = "ACTIVE" + + // KnowledgeBaseStatusDeleteInProgress is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusDeleteInProgress = "DELETE_IN_PROGRESS" + + // KnowledgeBaseStatusDeleteFailed is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusDeleteFailed = "DELETE_FAILED" + + // KnowledgeBaseStatusDeleted is a KnowledgeBaseStatus enum value + KnowledgeBaseStatusDeleted = "DELETED" +) + +// KnowledgeBaseStatus_Values returns all elements of the KnowledgeBaseStatus enum +func KnowledgeBaseStatus_Values() []string { + return []string{ + KnowledgeBaseStatusCreateInProgress, + KnowledgeBaseStatusCreateFailed, + KnowledgeBaseStatusActive, + KnowledgeBaseStatusDeleteInProgress, + KnowledgeBaseStatusDeleteFailed, + KnowledgeBaseStatusDeleted, + } +} + +const ( + // KnowledgeBaseTypeExternal is a KnowledgeBaseType enum value + KnowledgeBaseTypeExternal = "EXTERNAL" + + // KnowledgeBaseTypeCustom is a KnowledgeBaseType enum value + KnowledgeBaseTypeCustom = "CUSTOM" +) + +// KnowledgeBaseType_Values returns all elements of the KnowledgeBaseType enum +func KnowledgeBaseType_Values() []string { + return []string{ + KnowledgeBaseTypeExternal, + KnowledgeBaseTypeCustom, + } +} + +const ( + // RelevanceLevelHigh is a RelevanceLevel enum value + RelevanceLevelHigh = "HIGH" + + // RelevanceLevelMedium is a RelevanceLevel enum value + RelevanceLevelMedium = "MEDIUM" + + // RelevanceLevelLow is a RelevanceLevel enum value + RelevanceLevelLow = "LOW" +) + +// RelevanceLevel_Values returns all elements of the RelevanceLevel enum +func RelevanceLevel_Values() []string { + return []string{ + RelevanceLevelHigh, + RelevanceLevelMedium, + RelevanceLevelLow, + } +} diff --git a/service/connectwisdomservice/connectwisdomserviceiface/interface.go b/service/connectwisdomservice/connectwisdomserviceiface/interface.go new file mode 100644 index 00000000000..e2e90db8b0c --- /dev/null +++ b/service/connectwisdomservice/connectwisdomserviceiface/interface.go @@ -0,0 +1,209 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package connectwisdomserviceiface provides an interface to enable mocking the Amazon Connect Wisdom Service service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package connectwisdomserviceiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/connectwisdomservice" +) + +// ConnectWisdomServiceAPI provides an interface to enable mocking the +// connectwisdomservice.ConnectWisdomService service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon Connect Wisdom Service. +// func myFunc(svc connectwisdomserviceiface.ConnectWisdomServiceAPI) bool { +// // Make svc.CreateAssistant request +// } +// +// func main() { +// sess := session.New() +// svc := connectwisdomservice.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockConnectWisdomServiceClient struct { +// connectwisdomserviceiface.ConnectWisdomServiceAPI +// } +// func (m *mockConnectWisdomServiceClient) CreateAssistant(input *connectwisdomservice.CreateAssistantInput) (*connectwisdomservice.CreateAssistantOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockConnectWisdomServiceClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type ConnectWisdomServiceAPI interface { + CreateAssistant(*connectwisdomservice.CreateAssistantInput) (*connectwisdomservice.CreateAssistantOutput, error) + CreateAssistantWithContext(aws.Context, *connectwisdomservice.CreateAssistantInput, ...request.Option) (*connectwisdomservice.CreateAssistantOutput, error) + CreateAssistantRequest(*connectwisdomservice.CreateAssistantInput) (*request.Request, *connectwisdomservice.CreateAssistantOutput) + + CreateAssistantAssociation(*connectwisdomservice.CreateAssistantAssociationInput) (*connectwisdomservice.CreateAssistantAssociationOutput, error) + CreateAssistantAssociationWithContext(aws.Context, *connectwisdomservice.CreateAssistantAssociationInput, ...request.Option) (*connectwisdomservice.CreateAssistantAssociationOutput, error) + CreateAssistantAssociationRequest(*connectwisdomservice.CreateAssistantAssociationInput) (*request.Request, *connectwisdomservice.CreateAssistantAssociationOutput) + + CreateContent(*connectwisdomservice.CreateContentInput) (*connectwisdomservice.CreateContentOutput, error) + CreateContentWithContext(aws.Context, *connectwisdomservice.CreateContentInput, ...request.Option) (*connectwisdomservice.CreateContentOutput, error) + CreateContentRequest(*connectwisdomservice.CreateContentInput) (*request.Request, *connectwisdomservice.CreateContentOutput) + + CreateKnowledgeBase(*connectwisdomservice.CreateKnowledgeBaseInput) (*connectwisdomservice.CreateKnowledgeBaseOutput, error) + CreateKnowledgeBaseWithContext(aws.Context, *connectwisdomservice.CreateKnowledgeBaseInput, ...request.Option) (*connectwisdomservice.CreateKnowledgeBaseOutput, error) + CreateKnowledgeBaseRequest(*connectwisdomservice.CreateKnowledgeBaseInput) (*request.Request, *connectwisdomservice.CreateKnowledgeBaseOutput) + + CreateSession(*connectwisdomservice.CreateSessionInput) (*connectwisdomservice.CreateSessionOutput, error) + CreateSessionWithContext(aws.Context, *connectwisdomservice.CreateSessionInput, ...request.Option) (*connectwisdomservice.CreateSessionOutput, error) + CreateSessionRequest(*connectwisdomservice.CreateSessionInput) (*request.Request, *connectwisdomservice.CreateSessionOutput) + + DeleteAssistant(*connectwisdomservice.DeleteAssistantInput) (*connectwisdomservice.DeleteAssistantOutput, error) + DeleteAssistantWithContext(aws.Context, *connectwisdomservice.DeleteAssistantInput, ...request.Option) (*connectwisdomservice.DeleteAssistantOutput, error) + DeleteAssistantRequest(*connectwisdomservice.DeleteAssistantInput) (*request.Request, *connectwisdomservice.DeleteAssistantOutput) + + DeleteAssistantAssociation(*connectwisdomservice.DeleteAssistantAssociationInput) (*connectwisdomservice.DeleteAssistantAssociationOutput, error) + DeleteAssistantAssociationWithContext(aws.Context, *connectwisdomservice.DeleteAssistantAssociationInput, ...request.Option) (*connectwisdomservice.DeleteAssistantAssociationOutput, error) + DeleteAssistantAssociationRequest(*connectwisdomservice.DeleteAssistantAssociationInput) (*request.Request, *connectwisdomservice.DeleteAssistantAssociationOutput) + + DeleteContent(*connectwisdomservice.DeleteContentInput) (*connectwisdomservice.DeleteContentOutput, error) + DeleteContentWithContext(aws.Context, *connectwisdomservice.DeleteContentInput, ...request.Option) (*connectwisdomservice.DeleteContentOutput, error) + DeleteContentRequest(*connectwisdomservice.DeleteContentInput) (*request.Request, *connectwisdomservice.DeleteContentOutput) + + DeleteKnowledgeBase(*connectwisdomservice.DeleteKnowledgeBaseInput) (*connectwisdomservice.DeleteKnowledgeBaseOutput, error) + DeleteKnowledgeBaseWithContext(aws.Context, *connectwisdomservice.DeleteKnowledgeBaseInput, ...request.Option) (*connectwisdomservice.DeleteKnowledgeBaseOutput, error) + DeleteKnowledgeBaseRequest(*connectwisdomservice.DeleteKnowledgeBaseInput) (*request.Request, *connectwisdomservice.DeleteKnowledgeBaseOutput) + + GetAssistant(*connectwisdomservice.GetAssistantInput) (*connectwisdomservice.GetAssistantOutput, error) + GetAssistantWithContext(aws.Context, *connectwisdomservice.GetAssistantInput, ...request.Option) (*connectwisdomservice.GetAssistantOutput, error) + GetAssistantRequest(*connectwisdomservice.GetAssistantInput) (*request.Request, *connectwisdomservice.GetAssistantOutput) + + GetAssistantAssociation(*connectwisdomservice.GetAssistantAssociationInput) (*connectwisdomservice.GetAssistantAssociationOutput, error) + GetAssistantAssociationWithContext(aws.Context, *connectwisdomservice.GetAssistantAssociationInput, ...request.Option) (*connectwisdomservice.GetAssistantAssociationOutput, error) + GetAssistantAssociationRequest(*connectwisdomservice.GetAssistantAssociationInput) (*request.Request, *connectwisdomservice.GetAssistantAssociationOutput) + + GetContent(*connectwisdomservice.GetContentInput) (*connectwisdomservice.GetContentOutput, error) + GetContentWithContext(aws.Context, *connectwisdomservice.GetContentInput, ...request.Option) (*connectwisdomservice.GetContentOutput, error) + GetContentRequest(*connectwisdomservice.GetContentInput) (*request.Request, *connectwisdomservice.GetContentOutput) + + GetContentSummary(*connectwisdomservice.GetContentSummaryInput) (*connectwisdomservice.GetContentSummaryOutput, error) + GetContentSummaryWithContext(aws.Context, *connectwisdomservice.GetContentSummaryInput, ...request.Option) (*connectwisdomservice.GetContentSummaryOutput, error) + GetContentSummaryRequest(*connectwisdomservice.GetContentSummaryInput) (*request.Request, *connectwisdomservice.GetContentSummaryOutput) + + GetKnowledgeBase(*connectwisdomservice.GetKnowledgeBaseInput) (*connectwisdomservice.GetKnowledgeBaseOutput, error) + GetKnowledgeBaseWithContext(aws.Context, *connectwisdomservice.GetKnowledgeBaseInput, ...request.Option) (*connectwisdomservice.GetKnowledgeBaseOutput, error) + GetKnowledgeBaseRequest(*connectwisdomservice.GetKnowledgeBaseInput) (*request.Request, *connectwisdomservice.GetKnowledgeBaseOutput) + + GetRecommendations(*connectwisdomservice.GetRecommendationsInput) (*connectwisdomservice.GetRecommendationsOutput, error) + GetRecommendationsWithContext(aws.Context, *connectwisdomservice.GetRecommendationsInput, ...request.Option) (*connectwisdomservice.GetRecommendationsOutput, error) + GetRecommendationsRequest(*connectwisdomservice.GetRecommendationsInput) (*request.Request, *connectwisdomservice.GetRecommendationsOutput) + + GetSession(*connectwisdomservice.GetSessionInput) (*connectwisdomservice.GetSessionOutput, error) + GetSessionWithContext(aws.Context, *connectwisdomservice.GetSessionInput, ...request.Option) (*connectwisdomservice.GetSessionOutput, error) + GetSessionRequest(*connectwisdomservice.GetSessionInput) (*request.Request, *connectwisdomservice.GetSessionOutput) + + ListAssistantAssociations(*connectwisdomservice.ListAssistantAssociationsInput) (*connectwisdomservice.ListAssistantAssociationsOutput, error) + ListAssistantAssociationsWithContext(aws.Context, *connectwisdomservice.ListAssistantAssociationsInput, ...request.Option) (*connectwisdomservice.ListAssistantAssociationsOutput, error) + ListAssistantAssociationsRequest(*connectwisdomservice.ListAssistantAssociationsInput) (*request.Request, *connectwisdomservice.ListAssistantAssociationsOutput) + + ListAssistantAssociationsPages(*connectwisdomservice.ListAssistantAssociationsInput, func(*connectwisdomservice.ListAssistantAssociationsOutput, bool) bool) error + ListAssistantAssociationsPagesWithContext(aws.Context, *connectwisdomservice.ListAssistantAssociationsInput, func(*connectwisdomservice.ListAssistantAssociationsOutput, bool) bool, ...request.Option) error + + ListAssistants(*connectwisdomservice.ListAssistantsInput) (*connectwisdomservice.ListAssistantsOutput, error) + ListAssistantsWithContext(aws.Context, *connectwisdomservice.ListAssistantsInput, ...request.Option) (*connectwisdomservice.ListAssistantsOutput, error) + ListAssistantsRequest(*connectwisdomservice.ListAssistantsInput) (*request.Request, *connectwisdomservice.ListAssistantsOutput) + + ListAssistantsPages(*connectwisdomservice.ListAssistantsInput, func(*connectwisdomservice.ListAssistantsOutput, bool) bool) error + ListAssistantsPagesWithContext(aws.Context, *connectwisdomservice.ListAssistantsInput, func(*connectwisdomservice.ListAssistantsOutput, bool) bool, ...request.Option) error + + ListContents(*connectwisdomservice.ListContentsInput) (*connectwisdomservice.ListContentsOutput, error) + ListContentsWithContext(aws.Context, *connectwisdomservice.ListContentsInput, ...request.Option) (*connectwisdomservice.ListContentsOutput, error) + ListContentsRequest(*connectwisdomservice.ListContentsInput) (*request.Request, *connectwisdomservice.ListContentsOutput) + + ListContentsPages(*connectwisdomservice.ListContentsInput, func(*connectwisdomservice.ListContentsOutput, bool) bool) error + ListContentsPagesWithContext(aws.Context, *connectwisdomservice.ListContentsInput, func(*connectwisdomservice.ListContentsOutput, bool) bool, ...request.Option) error + + ListKnowledgeBases(*connectwisdomservice.ListKnowledgeBasesInput) (*connectwisdomservice.ListKnowledgeBasesOutput, error) + ListKnowledgeBasesWithContext(aws.Context, *connectwisdomservice.ListKnowledgeBasesInput, ...request.Option) (*connectwisdomservice.ListKnowledgeBasesOutput, error) + ListKnowledgeBasesRequest(*connectwisdomservice.ListKnowledgeBasesInput) (*request.Request, *connectwisdomservice.ListKnowledgeBasesOutput) + + ListKnowledgeBasesPages(*connectwisdomservice.ListKnowledgeBasesInput, func(*connectwisdomservice.ListKnowledgeBasesOutput, bool) bool) error + ListKnowledgeBasesPagesWithContext(aws.Context, *connectwisdomservice.ListKnowledgeBasesInput, func(*connectwisdomservice.ListKnowledgeBasesOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*connectwisdomservice.ListTagsForResourceInput) (*connectwisdomservice.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *connectwisdomservice.ListTagsForResourceInput, ...request.Option) (*connectwisdomservice.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*connectwisdomservice.ListTagsForResourceInput) (*request.Request, *connectwisdomservice.ListTagsForResourceOutput) + + NotifyRecommendationsReceived(*connectwisdomservice.NotifyRecommendationsReceivedInput) (*connectwisdomservice.NotifyRecommendationsReceivedOutput, error) + NotifyRecommendationsReceivedWithContext(aws.Context, *connectwisdomservice.NotifyRecommendationsReceivedInput, ...request.Option) (*connectwisdomservice.NotifyRecommendationsReceivedOutput, error) + NotifyRecommendationsReceivedRequest(*connectwisdomservice.NotifyRecommendationsReceivedInput) (*request.Request, *connectwisdomservice.NotifyRecommendationsReceivedOutput) + + QueryAssistant(*connectwisdomservice.QueryAssistantInput) (*connectwisdomservice.QueryAssistantOutput, error) + QueryAssistantWithContext(aws.Context, *connectwisdomservice.QueryAssistantInput, ...request.Option) (*connectwisdomservice.QueryAssistantOutput, error) + QueryAssistantRequest(*connectwisdomservice.QueryAssistantInput) (*request.Request, *connectwisdomservice.QueryAssistantOutput) + + QueryAssistantPages(*connectwisdomservice.QueryAssistantInput, func(*connectwisdomservice.QueryAssistantOutput, bool) bool) error + QueryAssistantPagesWithContext(aws.Context, *connectwisdomservice.QueryAssistantInput, func(*connectwisdomservice.QueryAssistantOutput, bool) bool, ...request.Option) error + + RemoveKnowledgeBaseTemplateUri(*connectwisdomservice.RemoveKnowledgeBaseTemplateUriInput) (*connectwisdomservice.RemoveKnowledgeBaseTemplateUriOutput, error) + RemoveKnowledgeBaseTemplateUriWithContext(aws.Context, *connectwisdomservice.RemoveKnowledgeBaseTemplateUriInput, ...request.Option) (*connectwisdomservice.RemoveKnowledgeBaseTemplateUriOutput, error) + RemoveKnowledgeBaseTemplateUriRequest(*connectwisdomservice.RemoveKnowledgeBaseTemplateUriInput) (*request.Request, *connectwisdomservice.RemoveKnowledgeBaseTemplateUriOutput) + + SearchContent(*connectwisdomservice.SearchContentInput) (*connectwisdomservice.SearchContentOutput, error) + SearchContentWithContext(aws.Context, *connectwisdomservice.SearchContentInput, ...request.Option) (*connectwisdomservice.SearchContentOutput, error) + SearchContentRequest(*connectwisdomservice.SearchContentInput) (*request.Request, *connectwisdomservice.SearchContentOutput) + + SearchContentPages(*connectwisdomservice.SearchContentInput, func(*connectwisdomservice.SearchContentOutput, bool) bool) error + SearchContentPagesWithContext(aws.Context, *connectwisdomservice.SearchContentInput, func(*connectwisdomservice.SearchContentOutput, bool) bool, ...request.Option) error + + SearchSessions(*connectwisdomservice.SearchSessionsInput) (*connectwisdomservice.SearchSessionsOutput, error) + SearchSessionsWithContext(aws.Context, *connectwisdomservice.SearchSessionsInput, ...request.Option) (*connectwisdomservice.SearchSessionsOutput, error) + SearchSessionsRequest(*connectwisdomservice.SearchSessionsInput) (*request.Request, *connectwisdomservice.SearchSessionsOutput) + + SearchSessionsPages(*connectwisdomservice.SearchSessionsInput, func(*connectwisdomservice.SearchSessionsOutput, bool) bool) error + SearchSessionsPagesWithContext(aws.Context, *connectwisdomservice.SearchSessionsInput, func(*connectwisdomservice.SearchSessionsOutput, bool) bool, ...request.Option) error + + StartContentUpload(*connectwisdomservice.StartContentUploadInput) (*connectwisdomservice.StartContentUploadOutput, error) + StartContentUploadWithContext(aws.Context, *connectwisdomservice.StartContentUploadInput, ...request.Option) (*connectwisdomservice.StartContentUploadOutput, error) + StartContentUploadRequest(*connectwisdomservice.StartContentUploadInput) (*request.Request, *connectwisdomservice.StartContentUploadOutput) + + TagResource(*connectwisdomservice.TagResourceInput) (*connectwisdomservice.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *connectwisdomservice.TagResourceInput, ...request.Option) (*connectwisdomservice.TagResourceOutput, error) + TagResourceRequest(*connectwisdomservice.TagResourceInput) (*request.Request, *connectwisdomservice.TagResourceOutput) + + UntagResource(*connectwisdomservice.UntagResourceInput) (*connectwisdomservice.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *connectwisdomservice.UntagResourceInput, ...request.Option) (*connectwisdomservice.UntagResourceOutput, error) + UntagResourceRequest(*connectwisdomservice.UntagResourceInput) (*request.Request, *connectwisdomservice.UntagResourceOutput) + + UpdateContent(*connectwisdomservice.UpdateContentInput) (*connectwisdomservice.UpdateContentOutput, error) + UpdateContentWithContext(aws.Context, *connectwisdomservice.UpdateContentInput, ...request.Option) (*connectwisdomservice.UpdateContentOutput, error) + UpdateContentRequest(*connectwisdomservice.UpdateContentInput) (*request.Request, *connectwisdomservice.UpdateContentOutput) + + UpdateKnowledgeBaseTemplateUri(*connectwisdomservice.UpdateKnowledgeBaseTemplateUriInput) (*connectwisdomservice.UpdateKnowledgeBaseTemplateUriOutput, error) + UpdateKnowledgeBaseTemplateUriWithContext(aws.Context, *connectwisdomservice.UpdateKnowledgeBaseTemplateUriInput, ...request.Option) (*connectwisdomservice.UpdateKnowledgeBaseTemplateUriOutput, error) + UpdateKnowledgeBaseTemplateUriRequest(*connectwisdomservice.UpdateKnowledgeBaseTemplateUriInput) (*request.Request, *connectwisdomservice.UpdateKnowledgeBaseTemplateUriOutput) +} + +var _ ConnectWisdomServiceAPI = (*connectwisdomservice.ConnectWisdomService)(nil) diff --git a/service/connectwisdomservice/doc.go b/service/connectwisdomservice/doc.go new file mode 100644 index 00000000000..0bf9094d798 --- /dev/null +++ b/service/connectwisdomservice/doc.go @@ -0,0 +1,33 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package connectwisdomservice provides the client and types for making API +// requests to Amazon Connect Wisdom Service. +// +// All Amazon Connect Wisdom functionality is accessible using the API. For +// example, you can create an assistant and a knowledge base. +// +//Some more advanced features are only accessible using the Wisdom API. +// For example, you can manually manage content by uploading custom files +// and control their lifecycle.
+// +// See https://docs.aws.amazon.com/goto/WebAPI/wisdom-2020-10-19 for more information on this service. +// +// See connectwisdomservice package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/connectwisdomservice/ +// +// Using the Client +// +// To contact Amazon Connect Wisdom Service with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon Connect Wisdom Service client ConnectWisdomService for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/connectwisdomservice/#New +package connectwisdomservice diff --git a/service/connectwisdomservice/errors.go b/service/connectwisdomservice/errors.go new file mode 100644 index 00000000000..0af26face99 --- /dev/null +++ b/service/connectwisdomservice/errors.go @@ -0,0 +1,69 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package connectwisdomservice + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // You do not have sufficient access to perform this action. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // The request could not be processed because of conflict in the current state + // of the resource. For example, if you're using a Create API (such as CreateAssistant) + // that accepts name, a conflicting resource (usually with the same name) is + // being created or mutated. + ErrCodeConflictException = "ConflictException" + + // ErrCodePreconditionFailedException for service response error code + // "PreconditionFailedException". + // + // The provided revisionId does not match, indicating the content has been modified + // since it was last read. + ErrCodePreconditionFailedException = "PreconditionFailedException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The specified resource does not exist. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // You've exceeded your service quota. To perform the requested action, remove + // some of the relevant resources, or use service quotas to request a service + // quota increase. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeTooManyTagsException for service response error code + // "TooManyTagsException". + // + // Amazon Connect Wisdom throws this exception if you have too many tags in + // your tag set. + ErrCodeTooManyTagsException = "TooManyTagsException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The input fails to satisfy the constraints specified by an AWS service. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "PreconditionFailedException": newErrorPreconditionFailedException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "TooManyTagsException": newErrorTooManyTagsException, + "ValidationException": newErrorValidationException, +} diff --git a/service/connectwisdomservice/service.go b/service/connectwisdomservice/service.go new file mode 100644 index 00000000000..ab574a7d65b --- /dev/null +++ b/service/connectwisdomservice/service.go @@ -0,0 +1,104 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package connectwisdomservice + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/restjson" +) + +// ConnectWisdomService provides the API operation methods for making requests to +// Amazon Connect Wisdom Service. See this package's package overview docs +// for details on the service. +// +// ConnectWisdomService methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type ConnectWisdomService struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Wisdom" // Name of service. + EndpointsID = "wisdom" // ID to lookup a service endpoint with. + ServiceID = "Wisdom" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the ConnectWisdomService client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a ConnectWisdomService client from just a session. +// svc := connectwisdomservice.New(mySession) +// +// // Create a ConnectWisdomService client with additional configuration +// svc := connectwisdomservice.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *ConnectWisdomService { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "wisdom" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *ConnectWisdomService { + svc := &ConnectWisdomService{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2020-10-19", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(restjson.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(restjson.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(restjson.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(restjson.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a ConnectWisdomService operation and runs any +// custom request initialization. +func (c *ConnectWisdomService) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/elbv2/api.go b/service/elbv2/api.go index 9d37925b8fb..1389dac8642 100644 --- a/service/elbv2/api.go +++ b/service/elbv2/api.go @@ -178,6 +178,12 @@ func (c *ELBV2) AddTagsRequest(input *AddTagsInput) (req *request.Request, outpu // * ErrCodeTargetGroupNotFoundException "TargetGroupNotFound" // The specified target group does not exist. // +// * ErrCodeListenerNotFoundException "ListenerNotFound" +// The specified listener does not exist. +// +// * ErrCodeRuleNotFoundException "RuleNotFound" +// The specified rule does not exist. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/AddTags func (c *ELBV2) AddTags(input *AddTagsInput) (*AddTagsOutput, error) { req, out := c.AddTagsRequest(input) @@ -770,6 +776,9 @@ func (c *ELBV2) DeleteListenerRequest(input *DeleteListenerInput) (req *request. // * ErrCodeListenerNotFoundException "ListenerNotFound" // The specified listener does not exist. // +// * ErrCodeResourceInUseException "ResourceInUse" +// A specified resource is in use. +// // See also, https://docs.aws.amazon.com/goto/WebAPI/elasticloadbalancingv2-2015-12-01/DeleteListener func (c *ELBV2) DeleteListener(input *DeleteListenerInput) (*DeleteListenerOutput, error) { req, out := c.DeleteListenerRequest(input) @@ -4799,7 +4808,7 @@ type CreateTargetGroupInput struct { // Indicates whether health checks are enabled. If the target type is lambda, // health checks are disabled by default but can be enabled. If the target type - // is instance or ip, health checks are always enabled and cannot be disabled. + // is instance, ip, or alb, health checks are always enabled and cannot be disabled. HealthCheckEnabled *bool `type:"boolean"` // The approximate amount of time, in seconds, between health checks of an individual @@ -4892,6 +4901,8 @@ type CreateTargetGroupInput struct { // addresses. // // * lambda - Register a single Lambda function as a target. + // + // * alb - Register a single Application Load Balancer as a target. TargetType *string `type:"string" enum:"TargetTypeEnum"` // The number of consecutive health check failures required before considering @@ -9503,7 +9514,7 @@ type TargetDescription struct { // from all enabled Availability Zones for the load balancer. // // This parameter is not supported if the target type of the target group is - // instance. + // instance or alb. // // If the target type is ip and the IP address is in a subnet of the VPC for // the target group, the Availability Zone is automatically detected and this @@ -9519,13 +9530,17 @@ type TargetDescription struct { // The ID of the target. If the target type of the target group is instance, // specify an instance ID. If the target type is ip, specify an IP address. - // If the target type is lambda, specify the ARN of the Lambda function. + // If the target type is lambda, specify the ARN of the Lambda function. If + // the target type is alb, specify the ARN of the Application Load Balancer + // target. // // Id is a required field Id *string `type:"string" required:"true"` // The port on which the target is listening. If the target group protocol is - // GENEVE, the supported port is 6081. Not used if the target is a Lambda function. + // GENEVE, the supported port is 6081. If the target type is alb, the targeted + // Application Load Balancer must have at least one listener whose port matches + // the target group port. Not used if the target is a Lambda function. Port *int64 `min:"1" type:"integer"` } @@ -9637,8 +9652,9 @@ type TargetGroup struct { // The type of target that you must specify when registering targets with this // target group. The possible values are instance (register targets by instance - // ID), ip (register targets by IP address), or lambda (register a single Lambda - // function as a target). + // ID), ip (register targets by IP address), lambda (register a single Lambda + // function as a target), or alb (register a single Application Load Balancer + // as a target). TargetType *string `type:"string" enum:"TargetTypeEnum"` // The number of consecutive health check failures required before considering @@ -10417,6 +10433,9 @@ const ( // TargetTypeEnumLambda is a TargetTypeEnum enum value TargetTypeEnumLambda = "lambda" + + // TargetTypeEnumAlb is a TargetTypeEnum enum value + TargetTypeEnumAlb = "alb" ) // TargetTypeEnum_Values returns all elements of the TargetTypeEnum enum @@ -10425,5 +10444,6 @@ func TargetTypeEnum_Values() []string { TargetTypeEnumInstance, TargetTypeEnumIp, TargetTypeEnumLambda, + TargetTypeEnumAlb, } } diff --git a/service/elbv2/examples_test.go b/service/elbv2/examples_test.go index 12578d90c83..4046bd2285e 100644 --- a/service/elbv2/examples_test.go +++ b/service/elbv2/examples_test.go @@ -58,6 +58,10 @@ func ExampleELBV2_AddTags_shared00() { fmt.Println(elbv2.ErrCodeLoadBalancerNotFoundException, aerr.Error()) case elbv2.ErrCodeTargetGroupNotFoundException: fmt.Println(elbv2.ErrCodeTargetGroupNotFoundException, aerr.Error()) + case elbv2.ErrCodeListenerNotFoundException: + fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error()) + case elbv2.ErrCodeRuleNotFoundException: + fmt.Println(elbv2.ErrCodeRuleNotFoundException, aerr.Error()) default: fmt.Println(aerr.Error()) } @@ -470,6 +474,8 @@ func ExampleELBV2_DeleteListener_shared00() { switch aerr.Code() { case elbv2.ErrCodeListenerNotFoundException: fmt.Println(elbv2.ErrCodeListenerNotFoundException, aerr.Error()) + case elbv2.ErrCodeResourceInUseException: + fmt.Println(elbv2.ErrCodeResourceInUseException, aerr.Error()) default: fmt.Println(aerr.Error()) } diff --git a/service/pinpoint/api.go b/service/pinpoint/api.go index 25c46bed4f0..9396181218b 100644 --- a/service/pinpoint/api.go +++ b/service/pinpoint/api.go @@ -13173,6 +13173,10 @@ type Activity struct { // down one of two paths in a journey, based on conditions that you specify. ConditionalSplit *ConditionalSplitActivity `type:"structure"` + // The settings for a connect activity. This type of activity initiates a contact + // center call to participants. + ContactCenter *ContactCenterActivity `type:"structure"` + // The custom description of the activity. Description *string `type:"string"` @@ -13263,6 +13267,12 @@ func (s *Activity) SetConditionalSplit(v *ConditionalSplitActivity) *Activity { return s } +// SetContactCenter sets the ContactCenter field's value. +func (s *Activity) SetContactCenter(v *ContactCenterActivity) *Activity { + s.ContactCenter = v + return s +} + // SetDescription sets the Description field's value. func (s *Activity) SetDescription(v string) *Activity { s.Description = &v @@ -15871,6 +15881,39 @@ func (s *ConflictException) RequestID() string { return s.RespMetadata.RequestID } +// The settings for a connect activity. This type of activity initiates a contact +// center call to participants. +type ContactCenterActivity struct { + _ struct{} `type:"structure"` + + // The unique identifier for the next activity to perform after the this activity. + NextActivity *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactCenterActivity) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ContactCenterActivity) GoString() string { + return s.String() +} + +// SetNextActivity sets the NextActivity field's value. +func (s *ContactCenterActivity) SetNextActivity(v string) *ContactCenterActivity { + s.NextActivity = &v + return s +} + type CreateAppInput struct { _ struct{} `type:"structure" payload:"CreateApplicationRequest"` @@ -29203,11 +29246,54 @@ func (s *ItemResponse) SetEventsItemResponse(v map[string]*EventItemResponse) *I return s } +// The channel-specific configurations for the journey. +type JourneyChannelSettings struct { + _ struct{} `type:"structure"` + + // Amazon Resource Name (ARN) of the Connect Campaign. + ConnectCampaignArn *string `type:"string"` + + // IAM role ARN to be assumed when invoking Connect campaign execution APIs + // for dialing. + ConnectCampaignExecutionRoleArn *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JourneyChannelSettings) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JourneyChannelSettings) GoString() string { + return s.String() +} + +// SetConnectCampaignArn sets the ConnectCampaignArn field's value. +func (s *JourneyChannelSettings) SetConnectCampaignArn(v string) *JourneyChannelSettings { + s.ConnectCampaignArn = &v + return s +} + +// SetConnectCampaignExecutionRoleArn sets the ConnectCampaignExecutionRoleArn field's value. +func (s *JourneyChannelSettings) SetConnectCampaignExecutionRoleArn(v string) *JourneyChannelSettings { + s.ConnectCampaignExecutionRoleArn = &v + return s +} + // Specifies the message content for a custom channel message that's sent to // participants in a journey. type JourneyCustomMessage struct { _ struct{} `type:"structure"` + // The message content that's passed to an AWS Lambda function or to a web hook. Data *string `type:"string"` } @@ -29683,6 +29769,9 @@ type JourneyResponse struct { // Id is a required field Id *string `type:"string" required:"true"` + // Amazon Resource Name (ARN) of the Connect Campaign. + JourneyChannelSettings *JourneyChannelSettings `type:"structure"` + // The date, in ISO 8601 format, when the journey was last modified. LastModifiedDate *string `type:"string"` @@ -29804,6 +29893,12 @@ func (s *JourneyResponse) SetId(v string) *JourneyResponse { return s } +// SetJourneyChannelSettings sets the JourneyChannelSettings field's value. +func (s *JourneyResponse) SetJourneyChannelSettings(v *JourneyChannelSettings) *JourneyResponse { + s.JourneyChannelSettings = v + return s +} + // SetLastModifiedDate sets the LastModifiedDate field's value. func (s *JourneyResponse) SetLastModifiedDate(v string) *JourneyResponse { s.LastModifiedDate = &v @@ -40257,6 +40352,10 @@ type WriteJourneyRequest struct { // The date, in ISO 8601 format, when the journey was created. CreationDate *string `type:"string"` + // IAM role ARN to be assumed when invoking Connect campaign execution APIs + // for dialing. + JourneyChannelSettings *JourneyChannelSettings `type:"structure"` + // The date, in ISO 8601 format, when the journey was last modified. LastModifiedDate *string `type:"string"` @@ -40384,6 +40483,12 @@ func (s *WriteJourneyRequest) SetCreationDate(v string) *WriteJourneyRequest { return s } +// SetJourneyChannelSettings sets the JourneyChannelSettings field's value. +func (s *WriteJourneyRequest) SetJourneyChannelSettings(v *JourneyChannelSettings) *WriteJourneyRequest { + s.JourneyChannelSettings = v + return s +} + // SetLastModifiedDate sets the LastModifiedDate field's value. func (s *WriteJourneyRequest) SetLastModifiedDate(v string) *WriteJourneyRequest { s.LastModifiedDate = &v diff --git a/service/voiceid/api.go b/service/voiceid/api.go new file mode 100644 index 00000000000..7e5ef52614b --- /dev/null +++ b/service/voiceid/api.go @@ -0,0 +1,7213 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package voiceid + +import ( + "fmt" + "time" + + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/awsutil" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" +) + +const opCreateDomain = "CreateDomain" + +// CreateDomainRequest generates a "aws/request.Request" representing the +// client's request for the CreateDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See CreateDomain for more information on using the CreateDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the CreateDomainRequest method. +// req, resp := client.CreateDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain +func (c *VoiceID) CreateDomainRequest(input *CreateDomainInput) (req *request.Request, output *CreateDomainOutput) { + op := &request.Operation{ + Name: opCreateDomain, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &CreateDomainInput{} + } + + output = &CreateDomainOutput{} + req = c.newRequest(op, input, output) + return +} + +// CreateDomain API operation for Amazon Voice ID. +// +// Creates a domain that contains all Amazon Connect Voice ID data, such as +// speakers, fraudsters, customer audio, and voiceprints. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation CreateDomain for usage and error information. +// +// Returned Error Types: +// * ServiceQuotaExceededException +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +// +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/CreateDomain +func (c *VoiceID) CreateDomain(input *CreateDomainInput) (*CreateDomainOutput, error) { + req, out := c.CreateDomainRequest(input) + return out, req.Send() +} + +// CreateDomainWithContext is the same as CreateDomain with the addition of +// the ability to pass a context and additional request options. +// +// See CreateDomain for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) CreateDomainWithContext(ctx aws.Context, input *CreateDomainInput, opts ...request.Option) (*CreateDomainOutput, error) { + req, out := c.CreateDomainRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteDomain = "DeleteDomain" + +// DeleteDomainRequest generates a "aws/request.Request" representing the +// client's request for the DeleteDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteDomain for more information on using the DeleteDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteDomainRequest method. +// req, resp := client.DeleteDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteDomain +func (c *VoiceID) DeleteDomainRequest(input *DeleteDomainInput) (req *request.Request, output *DeleteDomainOutput) { + op := &request.Operation{ + Name: opDeleteDomain, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteDomainInput{} + } + + output = &DeleteDomainOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteDomain API operation for Amazon Voice ID. +// +// Deletes the specified domain from the Amazon Connect Voice ID system. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DeleteDomain for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteDomain +func (c *VoiceID) DeleteDomain(input *DeleteDomainInput) (*DeleteDomainOutput, error) { + req, out := c.DeleteDomainRequest(input) + return out, req.Send() +} + +// DeleteDomainWithContext is the same as DeleteDomain with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteDomain for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DeleteDomainWithContext(ctx aws.Context, input *DeleteDomainInput, opts ...request.Option) (*DeleteDomainOutput, error) { + req, out := c.DeleteDomainRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteFraudster = "DeleteFraudster" + +// DeleteFraudsterRequest generates a "aws/request.Request" representing the +// client's request for the DeleteFraudster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteFraudster for more information on using the DeleteFraudster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteFraudsterRequest method. +// req, resp := client.DeleteFraudsterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteFraudster +func (c *VoiceID) DeleteFraudsterRequest(input *DeleteFraudsterInput) (req *request.Request, output *DeleteFraudsterOutput) { + op := &request.Operation{ + Name: opDeleteFraudster, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteFraudsterInput{} + } + + output = &DeleteFraudsterOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteFraudster API operation for Amazon Voice ID. +// +// Deletes the specified fraudster from the Amazon Connect Voice ID system. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DeleteFraudster for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteFraudster +func (c *VoiceID) DeleteFraudster(input *DeleteFraudsterInput) (*DeleteFraudsterOutput, error) { + req, out := c.DeleteFraudsterRequest(input) + return out, req.Send() +} + +// DeleteFraudsterWithContext is the same as DeleteFraudster with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteFraudster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DeleteFraudsterWithContext(ctx aws.Context, input *DeleteFraudsterInput, opts ...request.Option) (*DeleteFraudsterOutput, error) { + req, out := c.DeleteFraudsterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDeleteSpeaker = "DeleteSpeaker" + +// DeleteSpeakerRequest generates a "aws/request.Request" representing the +// client's request for the DeleteSpeaker operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DeleteSpeaker for more information on using the DeleteSpeaker +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DeleteSpeakerRequest method. +// req, resp := client.DeleteSpeakerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteSpeaker +func (c *VoiceID) DeleteSpeakerRequest(input *DeleteSpeakerInput) (req *request.Request, output *DeleteSpeakerOutput) { + op := &request.Operation{ + Name: opDeleteSpeaker, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DeleteSpeakerInput{} + } + + output = &DeleteSpeakerOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// DeleteSpeaker API operation for Amazon Voice ID. +// +// Deletes the specified speaker from the Amazon Connect Voice ID system. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DeleteSpeaker for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DeleteSpeaker +func (c *VoiceID) DeleteSpeaker(input *DeleteSpeakerInput) (*DeleteSpeakerOutput, error) { + req, out := c.DeleteSpeakerRequest(input) + return out, req.Send() +} + +// DeleteSpeakerWithContext is the same as DeleteSpeaker with the addition of +// the ability to pass a context and additional request options. +// +// See DeleteSpeaker for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DeleteSpeakerWithContext(ctx aws.Context, input *DeleteSpeakerInput, opts ...request.Option) (*DeleteSpeakerOutput, error) { + req, out := c.DeleteSpeakerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeDomain = "DescribeDomain" + +// DescribeDomainRequest generates a "aws/request.Request" representing the +// client's request for the DescribeDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeDomain for more information on using the DescribeDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeDomainRequest method. +// req, resp := client.DescribeDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain +func (c *VoiceID) DescribeDomainRequest(input *DescribeDomainInput) (req *request.Request, output *DescribeDomainOutput) { + op := &request.Operation{ + Name: opDescribeDomain, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeDomainInput{} + } + + output = &DescribeDomainOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeDomain API operation for Amazon Voice ID. +// +// Describes the specified domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeDomain for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeDomain +func (c *VoiceID) DescribeDomain(input *DescribeDomainInput) (*DescribeDomainOutput, error) { + req, out := c.DescribeDomainRequest(input) + return out, req.Send() +} + +// DescribeDomainWithContext is the same as DescribeDomain with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeDomain for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeDomainWithContext(ctx aws.Context, input *DescribeDomainInput, opts ...request.Option) (*DescribeDomainOutput, error) { + req, out := c.DescribeDomainRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeFraudster = "DescribeFraudster" + +// DescribeFraudsterRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFraudster operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeFraudster for more information on using the DescribeFraudster +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeFraudsterRequest method. +// req, resp := client.DescribeFraudsterRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudster +func (c *VoiceID) DescribeFraudsterRequest(input *DescribeFraudsterInput) (req *request.Request, output *DescribeFraudsterOutput) { + op := &request.Operation{ + Name: opDescribeFraudster, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeFraudsterInput{} + } + + output = &DescribeFraudsterOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeFraudster API operation for Amazon Voice ID. +// +// Describes the specified fraudster. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeFraudster for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudster +func (c *VoiceID) DescribeFraudster(input *DescribeFraudsterInput) (*DescribeFraudsterOutput, error) { + req, out := c.DescribeFraudsterRequest(input) + return out, req.Send() +} + +// DescribeFraudsterWithContext is the same as DescribeFraudster with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeFraudster for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeFraudsterWithContext(ctx aws.Context, input *DescribeFraudsterInput, opts ...request.Option) (*DescribeFraudsterOutput, error) { + req, out := c.DescribeFraudsterRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeFraudsterRegistrationJob = "DescribeFraudsterRegistrationJob" + +// DescribeFraudsterRegistrationJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeFraudsterRegistrationJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeFraudsterRegistrationJob for more information on using the DescribeFraudsterRegistrationJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeFraudsterRegistrationJobRequest method. +// req, resp := client.DescribeFraudsterRegistrationJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJob +func (c *VoiceID) DescribeFraudsterRegistrationJobRequest(input *DescribeFraudsterRegistrationJobInput) (req *request.Request, output *DescribeFraudsterRegistrationJobOutput) { + op := &request.Operation{ + Name: opDescribeFraudsterRegistrationJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeFraudsterRegistrationJobInput{} + } + + output = &DescribeFraudsterRegistrationJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeFraudsterRegistrationJob API operation for Amazon Voice ID. +// +// Describes the specified fraudster registration job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeFraudsterRegistrationJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeFraudsterRegistrationJob +func (c *VoiceID) DescribeFraudsterRegistrationJob(input *DescribeFraudsterRegistrationJobInput) (*DescribeFraudsterRegistrationJobOutput, error) { + req, out := c.DescribeFraudsterRegistrationJobRequest(input) + return out, req.Send() +} + +// DescribeFraudsterRegistrationJobWithContext is the same as DescribeFraudsterRegistrationJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeFraudsterRegistrationJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeFraudsterRegistrationJobWithContext(ctx aws.Context, input *DescribeFraudsterRegistrationJobInput, opts ...request.Option) (*DescribeFraudsterRegistrationJobOutput, error) { + req, out := c.DescribeFraudsterRegistrationJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeSpeaker = "DescribeSpeaker" + +// DescribeSpeakerRequest generates a "aws/request.Request" representing the +// client's request for the DescribeSpeaker operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeSpeaker for more information on using the DescribeSpeaker +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeSpeakerRequest method. +// req, resp := client.DescribeSpeakerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeaker +func (c *VoiceID) DescribeSpeakerRequest(input *DescribeSpeakerInput) (req *request.Request, output *DescribeSpeakerOutput) { + op := &request.Operation{ + Name: opDescribeSpeaker, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeSpeakerInput{} + } + + output = &DescribeSpeakerOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeSpeaker API operation for Amazon Voice ID. +// +// Describes the specified speaker. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeSpeaker for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeaker +func (c *VoiceID) DescribeSpeaker(input *DescribeSpeakerInput) (*DescribeSpeakerOutput, error) { + req, out := c.DescribeSpeakerRequest(input) + return out, req.Send() +} + +// DescribeSpeakerWithContext is the same as DescribeSpeaker with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeSpeaker for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeSpeakerWithContext(ctx aws.Context, input *DescribeSpeakerInput, opts ...request.Option) (*DescribeSpeakerOutput, error) { + req, out := c.DescribeSpeakerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opDescribeSpeakerEnrollmentJob = "DescribeSpeakerEnrollmentJob" + +// DescribeSpeakerEnrollmentJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribeSpeakerEnrollmentJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See DescribeSpeakerEnrollmentJob for more information on using the DescribeSpeakerEnrollmentJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the DescribeSpeakerEnrollmentJobRequest method. +// req, resp := client.DescribeSpeakerEnrollmentJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob +func (c *VoiceID) DescribeSpeakerEnrollmentJobRequest(input *DescribeSpeakerEnrollmentJobInput) (req *request.Request, output *DescribeSpeakerEnrollmentJobOutput) { + op := &request.Operation{ + Name: opDescribeSpeakerEnrollmentJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribeSpeakerEnrollmentJobInput{} + } + + output = &DescribeSpeakerEnrollmentJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribeSpeakerEnrollmentJob API operation for Amazon Voice ID. +// +// Describes the specified speaker enrollment job. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation DescribeSpeakerEnrollmentJob for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/DescribeSpeakerEnrollmentJob +func (c *VoiceID) DescribeSpeakerEnrollmentJob(input *DescribeSpeakerEnrollmentJobInput) (*DescribeSpeakerEnrollmentJobOutput, error) { + req, out := c.DescribeSpeakerEnrollmentJobRequest(input) + return out, req.Send() +} + +// DescribeSpeakerEnrollmentJobWithContext is the same as DescribeSpeakerEnrollmentJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribeSpeakerEnrollmentJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) DescribeSpeakerEnrollmentJobWithContext(ctx aws.Context, input *DescribeSpeakerEnrollmentJobInput, opts ...request.Option) (*DescribeSpeakerEnrollmentJobOutput, error) { + req, out := c.DescribeSpeakerEnrollmentJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opEvaluateSession = "EvaluateSession" + +// EvaluateSessionRequest generates a "aws/request.Request" representing the +// client's request for the EvaluateSession operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See EvaluateSession for more information on using the EvaluateSession +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the EvaluateSessionRequest method. +// req, resp := client.EvaluateSessionRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession +func (c *VoiceID) EvaluateSessionRequest(input *EvaluateSessionInput) (req *request.Request, output *EvaluateSessionOutput) { + op := &request.Operation{ + Name: opEvaluateSession, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &EvaluateSessionInput{} + } + + output = &EvaluateSessionOutput{} + req = c.newRequest(op, input, output) + return +} + +// EvaluateSession API operation for Amazon Voice ID. +// +// Evaluates a specified session based on audio data accumulated during a streaming +// Amazon Connect Voice ID call. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation EvaluateSession for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/EvaluateSession +func (c *VoiceID) EvaluateSession(input *EvaluateSessionInput) (*EvaluateSessionOutput, error) { + req, out := c.EvaluateSessionRequest(input) + return out, req.Send() +} + +// EvaluateSessionWithContext is the same as EvaluateSession with the addition of +// the ability to pass a context and additional request options. +// +// See EvaluateSession for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) EvaluateSessionWithContext(ctx aws.Context, input *EvaluateSessionInput, opts ...request.Option) (*EvaluateSessionOutput, error) { + req, out := c.EvaluateSessionRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opListDomains = "ListDomains" + +// ListDomainsRequest generates a "aws/request.Request" representing the +// client's request for the ListDomains operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListDomains for more information on using the ListDomains +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListDomainsRequest method. +// req, resp := client.ListDomainsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListDomains +func (c *VoiceID) ListDomainsRequest(input *ListDomainsInput) (req *request.Request, output *ListDomainsOutput) { + op := &request.Operation{ + Name: opListDomains, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListDomainsInput{} + } + + output = &ListDomainsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListDomains API operation for Amazon Voice ID. +// +// Lists all the domains in the Amazon Web Services account. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListDomains for usage and error information. +// +// Returned Error Types: +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListDomains +func (c *VoiceID) ListDomains(input *ListDomainsInput) (*ListDomainsOutput, error) { + req, out := c.ListDomainsRequest(input) + return out, req.Send() +} + +// ListDomainsWithContext is the same as ListDomains with the addition of +// the ability to pass a context and additional request options. +// +// See ListDomains for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListDomainsWithContext(ctx aws.Context, input *ListDomainsInput, opts ...request.Option) (*ListDomainsOutput, error) { + req, out := c.ListDomainsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListDomainsPages iterates over the pages of a ListDomains operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListDomains method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListDomains operation. +// pageNum := 0 +// err := client.ListDomainsPages(params, +// func(page *voiceid.ListDomainsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *VoiceID) ListDomainsPages(input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool) error { + return c.ListDomainsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListDomainsPagesWithContext same as ListDomainsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListDomainsPagesWithContext(ctx aws.Context, input *ListDomainsInput, fn func(*ListDomainsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListDomainsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListDomainsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListDomainsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListFraudsterRegistrationJobs = "ListFraudsterRegistrationJobs" + +// ListFraudsterRegistrationJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListFraudsterRegistrationJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListFraudsterRegistrationJobs for more information on using the ListFraudsterRegistrationJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListFraudsterRegistrationJobsRequest method. +// req, resp := client.ListFraudsterRegistrationJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsterRegistrationJobs +func (c *VoiceID) ListFraudsterRegistrationJobsRequest(input *ListFraudsterRegistrationJobsInput) (req *request.Request, output *ListFraudsterRegistrationJobsOutput) { + op := &request.Operation{ + Name: opListFraudsterRegistrationJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListFraudsterRegistrationJobsInput{} + } + + output = &ListFraudsterRegistrationJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListFraudsterRegistrationJobs API operation for Amazon Voice ID. +// +// Lists all the fraudster registration jobs in the domain with the given JobStatus. +// If JobStatus is not provided, this lists all fraudster registration jobs +// in the given domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListFraudsterRegistrationJobs for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListFraudsterRegistrationJobs +func (c *VoiceID) ListFraudsterRegistrationJobs(input *ListFraudsterRegistrationJobsInput) (*ListFraudsterRegistrationJobsOutput, error) { + req, out := c.ListFraudsterRegistrationJobsRequest(input) + return out, req.Send() +} + +// ListFraudsterRegistrationJobsWithContext is the same as ListFraudsterRegistrationJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListFraudsterRegistrationJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListFraudsterRegistrationJobsWithContext(ctx aws.Context, input *ListFraudsterRegistrationJobsInput, opts ...request.Option) (*ListFraudsterRegistrationJobsOutput, error) { + req, out := c.ListFraudsterRegistrationJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListFraudsterRegistrationJobsPages iterates over the pages of a ListFraudsterRegistrationJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListFraudsterRegistrationJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListFraudsterRegistrationJobs operation. +// pageNum := 0 +// err := client.ListFraudsterRegistrationJobsPages(params, +// func(page *voiceid.ListFraudsterRegistrationJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *VoiceID) ListFraudsterRegistrationJobsPages(input *ListFraudsterRegistrationJobsInput, fn func(*ListFraudsterRegistrationJobsOutput, bool) bool) error { + return c.ListFraudsterRegistrationJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListFraudsterRegistrationJobsPagesWithContext same as ListFraudsterRegistrationJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListFraudsterRegistrationJobsPagesWithContext(ctx aws.Context, input *ListFraudsterRegistrationJobsInput, fn func(*ListFraudsterRegistrationJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListFraudsterRegistrationJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListFraudsterRegistrationJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListFraudsterRegistrationJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSpeakerEnrollmentJobs = "ListSpeakerEnrollmentJobs" + +// ListSpeakerEnrollmentJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListSpeakerEnrollmentJobs operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSpeakerEnrollmentJobs for more information on using the ListSpeakerEnrollmentJobs +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListSpeakerEnrollmentJobsRequest method. +// req, resp := client.ListSpeakerEnrollmentJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs +func (c *VoiceID) ListSpeakerEnrollmentJobsRequest(input *ListSpeakerEnrollmentJobsInput) (req *request.Request, output *ListSpeakerEnrollmentJobsOutput) { + op := &request.Operation{ + Name: opListSpeakerEnrollmentJobs, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSpeakerEnrollmentJobsInput{} + } + + output = &ListSpeakerEnrollmentJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSpeakerEnrollmentJobs API operation for Amazon Voice ID. +// +// Lists all the speaker enrollment jobs in the domain with the specified JobStatus. +// If JobStatus is not provided, this lists all jobs with all possible speaker +// enrollment job statuses. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListSpeakerEnrollmentJobs for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakerEnrollmentJobs +func (c *VoiceID) ListSpeakerEnrollmentJobs(input *ListSpeakerEnrollmentJobsInput) (*ListSpeakerEnrollmentJobsOutput, error) { + req, out := c.ListSpeakerEnrollmentJobsRequest(input) + return out, req.Send() +} + +// ListSpeakerEnrollmentJobsWithContext is the same as ListSpeakerEnrollmentJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListSpeakerEnrollmentJobs for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakerEnrollmentJobsWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, opts ...request.Option) (*ListSpeakerEnrollmentJobsOutput, error) { + req, out := c.ListSpeakerEnrollmentJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSpeakerEnrollmentJobsPages iterates over the pages of a ListSpeakerEnrollmentJobs operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSpeakerEnrollmentJobs method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListSpeakerEnrollmentJobs operation. +// pageNum := 0 +// err := client.ListSpeakerEnrollmentJobsPages(params, +// func(page *voiceid.ListSpeakerEnrollmentJobsOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *VoiceID) ListSpeakerEnrollmentJobsPages(input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool) error { + return c.ListSpeakerEnrollmentJobsPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSpeakerEnrollmentJobsPagesWithContext same as ListSpeakerEnrollmentJobsPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakerEnrollmentJobsPagesWithContext(ctx aws.Context, input *ListSpeakerEnrollmentJobsInput, fn func(*ListSpeakerEnrollmentJobsOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSpeakerEnrollmentJobsInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSpeakerEnrollmentJobsRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSpeakerEnrollmentJobsOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListSpeakers = "ListSpeakers" + +// ListSpeakersRequest generates a "aws/request.Request" representing the +// client's request for the ListSpeakers operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListSpeakers for more information on using the ListSpeakers +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListSpeakersRequest method. +// req, resp := client.ListSpeakersRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers +func (c *VoiceID) ListSpeakersRequest(input *ListSpeakersInput) (req *request.Request, output *ListSpeakersOutput) { + op := &request.Operation{ + Name: opListSpeakers, + HTTPMethod: "POST", + HTTPPath: "/", + Paginator: &request.Paginator{ + InputTokens: []string{"NextToken"}, + OutputTokens: []string{"NextToken"}, + LimitToken: "MaxResults", + TruncationToken: "", + }, + } + + if input == nil { + input = &ListSpeakersInput{} + } + + output = &ListSpeakersOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListSpeakers API operation for Amazon Voice ID. +// +// Lists all speakers in a specified domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListSpeakers for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListSpeakers +func (c *VoiceID) ListSpeakers(input *ListSpeakersInput) (*ListSpeakersOutput, error) { + req, out := c.ListSpeakersRequest(input) + return out, req.Send() +} + +// ListSpeakersWithContext is the same as ListSpeakers with the addition of +// the ability to pass a context and additional request options. +// +// See ListSpeakers for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakersWithContext(ctx aws.Context, input *ListSpeakersInput, opts ...request.Option) (*ListSpeakersOutput, error) { + req, out := c.ListSpeakersRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// ListSpeakersPages iterates over the pages of a ListSpeakers operation, +// calling the "fn" function with the response data for each page. To stop +// iterating, return false from the fn function. +// +// See ListSpeakers method for more information on how to use this operation. +// +// Note: This operation can generate multiple requests to a service. +// +// // Example iterating over at most 3 pages of a ListSpeakers operation. +// pageNum := 0 +// err := client.ListSpeakersPages(params, +// func(page *voiceid.ListSpeakersOutput, lastPage bool) bool { +// pageNum++ +// fmt.Println(page) +// return pageNum <= 3 +// }) +// +func (c *VoiceID) ListSpeakersPages(input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool) error { + return c.ListSpeakersPagesWithContext(aws.BackgroundContext(), input, fn) +} + +// ListSpeakersPagesWithContext same as ListSpeakersPages except +// it takes a Context and allows setting request options on the pages. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListSpeakersPagesWithContext(ctx aws.Context, input *ListSpeakersInput, fn func(*ListSpeakersOutput, bool) bool, opts ...request.Option) error { + p := request.Pagination{ + NewRequest: func() (*request.Request, error) { + var inCpy *ListSpeakersInput + if input != nil { + tmp := *input + inCpy = &tmp + } + req, _ := c.ListSpeakersRequest(inCpy) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return req, nil + }, + } + + for p.Next() { + if !fn(p.Page().(*ListSpeakersOutput), !p.HasNextPage()) { + break + } + } + + return p.Err() +} + +const opListTagsForResource = "ListTagsForResource" + +// ListTagsForResourceRequest generates a "aws/request.Request" representing the +// client's request for the ListTagsForResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See ListTagsForResource for more information on using the ListTagsForResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the ListTagsForResourceRequest method. +// req, resp := client.ListTagsForResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListTagsForResource +func (c *VoiceID) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput) { + op := &request.Operation{ + Name: opListTagsForResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListTagsForResourceInput{} + } + + output = &ListTagsForResourceOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListTagsForResource API operation for Amazon Voice ID. +// +// Lists all tags associated with a specified Voice ID resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation ListTagsForResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/ListTagsForResource +func (c *VoiceID) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + return out, req.Send() +} + +// ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of +// the ability to pass a context and additional request options. +// +// See ListTagsForResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error) { + req, out := c.ListTagsForResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opOptOutSpeaker = "OptOutSpeaker" + +// OptOutSpeakerRequest generates a "aws/request.Request" representing the +// client's request for the OptOutSpeaker operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See OptOutSpeaker for more information on using the OptOutSpeaker +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the OptOutSpeakerRequest method. +// req, resp := client.OptOutSpeakerRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/OptOutSpeaker +func (c *VoiceID) OptOutSpeakerRequest(input *OptOutSpeakerInput) (req *request.Request, output *OptOutSpeakerOutput) { + op := &request.Operation{ + Name: opOptOutSpeaker, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &OptOutSpeakerInput{} + } + + output = &OptOutSpeakerOutput{} + req = c.newRequest(op, input, output) + return +} + +// OptOutSpeaker API operation for Amazon Voice ID. +// +// Opts out a speaker from Voice ID system. A speaker can be opted out regardless +// of whether or not they already exist in the system. If they don't yet exist, +// a new speaker is created in an opted out state. If they already exist, their +// existing status is overridden and they are opted out. Enrollment and evaluation +// authentication requests are rejected for opted out speakers, and opted out +// speakers have no voice embeddings stored in the system. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation OptOutSpeaker for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/OptOutSpeaker +func (c *VoiceID) OptOutSpeaker(input *OptOutSpeakerInput) (*OptOutSpeakerOutput, error) { + req, out := c.OptOutSpeakerRequest(input) + return out, req.Send() +} + +// OptOutSpeakerWithContext is the same as OptOutSpeaker with the addition of +// the ability to pass a context and additional request options. +// +// See OptOutSpeaker for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) OptOutSpeakerWithContext(ctx aws.Context, input *OptOutSpeakerInput, opts ...request.Option) (*OptOutSpeakerOutput, error) { + req, out := c.OptOutSpeakerRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartFraudsterRegistrationJob = "StartFraudsterRegistrationJob" + +// StartFraudsterRegistrationJobRequest generates a "aws/request.Request" representing the +// client's request for the StartFraudsterRegistrationJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartFraudsterRegistrationJob for more information on using the StartFraudsterRegistrationJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartFraudsterRegistrationJobRequest method. +// req, resp := client.StartFraudsterRegistrationJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartFraudsterRegistrationJob +func (c *VoiceID) StartFraudsterRegistrationJobRequest(input *StartFraudsterRegistrationJobInput) (req *request.Request, output *StartFraudsterRegistrationJobOutput) { + op := &request.Operation{ + Name: opStartFraudsterRegistrationJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartFraudsterRegistrationJobInput{} + } + + output = &StartFraudsterRegistrationJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartFraudsterRegistrationJob API operation for Amazon Voice ID. +// +// Starts a new batch fraudster registration job using provided details. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation StartFraudsterRegistrationJob for usage and error information. +// +// Returned Error Types: +// * ServiceQuotaExceededException +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +// +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartFraudsterRegistrationJob +func (c *VoiceID) StartFraudsterRegistrationJob(input *StartFraudsterRegistrationJobInput) (*StartFraudsterRegistrationJobOutput, error) { + req, out := c.StartFraudsterRegistrationJobRequest(input) + return out, req.Send() +} + +// StartFraudsterRegistrationJobWithContext is the same as StartFraudsterRegistrationJob with the addition of +// the ability to pass a context and additional request options. +// +// See StartFraudsterRegistrationJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) StartFraudsterRegistrationJobWithContext(ctx aws.Context, input *StartFraudsterRegistrationJobInput, opts ...request.Option) (*StartFraudsterRegistrationJobOutput, error) { + req, out := c.StartFraudsterRegistrationJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartSpeakerEnrollmentJob = "StartSpeakerEnrollmentJob" + +// StartSpeakerEnrollmentJobRequest generates a "aws/request.Request" representing the +// client's request for the StartSpeakerEnrollmentJob operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See StartSpeakerEnrollmentJob for more information on using the StartSpeakerEnrollmentJob +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the StartSpeakerEnrollmentJobRequest method. +// req, resp := client.StartSpeakerEnrollmentJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartSpeakerEnrollmentJob +func (c *VoiceID) StartSpeakerEnrollmentJobRequest(input *StartSpeakerEnrollmentJobInput) (req *request.Request, output *StartSpeakerEnrollmentJobOutput) { + op := &request.Operation{ + Name: opStartSpeakerEnrollmentJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartSpeakerEnrollmentJobInput{} + } + + output = &StartSpeakerEnrollmentJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartSpeakerEnrollmentJob API operation for Amazon Voice ID. +// +// Starts a new batch speaker enrollment job using specified details. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation StartSpeakerEnrollmentJob for usage and error information. +// +// Returned Error Types: +// * ServiceQuotaExceededException +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +// +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/StartSpeakerEnrollmentJob +func (c *VoiceID) StartSpeakerEnrollmentJob(input *StartSpeakerEnrollmentJobInput) (*StartSpeakerEnrollmentJobOutput, error) { + req, out := c.StartSpeakerEnrollmentJobRequest(input) + return out, req.Send() +} + +// StartSpeakerEnrollmentJobWithContext is the same as StartSpeakerEnrollmentJob with the addition of +// the ability to pass a context and additional request options. +// +// See StartSpeakerEnrollmentJob for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) StartSpeakerEnrollmentJobWithContext(ctx aws.Context, input *StartSpeakerEnrollmentJobInput, opts ...request.Option) (*StartSpeakerEnrollmentJobOutput, error) { + req, out := c.StartSpeakerEnrollmentJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opTagResource = "TagResource" + +// TagResourceRequest generates a "aws/request.Request" representing the +// client's request for the TagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See TagResource for more information on using the TagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the TagResourceRequest method. +// req, resp := client.TagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/TagResource +func (c *VoiceID) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput) { + op := &request.Operation{ + Name: opTagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &TagResourceInput{} + } + + output = &TagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// TagResource API operation for Amazon Voice ID. +// +// Tags an Amazon Connect Voice ID resource with the provided list of tags. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation TagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/TagResource +func (c *VoiceID) TagResource(input *TagResourceInput) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + return out, req.Send() +} + +// TagResourceWithContext is the same as TagResource with the addition of +// the ability to pass a context and additional request options. +// +// See TagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error) { + req, out := c.TagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUntagResource = "UntagResource" + +// UntagResourceRequest generates a "aws/request.Request" representing the +// client's request for the UntagResource operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UntagResource for more information on using the UntagResource +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UntagResourceRequest method. +// req, resp := client.UntagResourceRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource +func (c *VoiceID) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput) { + op := &request.Operation{ + Name: opUntagResource, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UntagResourceInput{} + } + + output = &UntagResourceOutput{} + req = c.newRequest(op, input, output) + req.Handlers.Unmarshal.Swap(jsonrpc.UnmarshalHandler.Name, protocol.UnmarshalDiscardBodyHandler) + return +} + +// UntagResource API operation for Amazon Voice ID. +// +// Removes specified tags from a specified Amazon Connect Voice ID resource. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation UntagResource for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UntagResource +func (c *VoiceID) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + return out, req.Send() +} + +// UntagResourceWithContext is the same as UntagResource with the addition of +// the ability to pass a context and additional request options. +// +// See UntagResource for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error) { + req, out := c.UntagResourceRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opUpdateDomain = "UpdateDomain" + +// UpdateDomainRequest generates a "aws/request.Request" representing the +// client's request for the UpdateDomain operation. The "output" return +// value will be populated with the request's response once the request completes +// successfully. +// +// Use "Send" method on the returned Request to send the API call to the service. +// the "output" return value is not valid until after Send returns without error. +// +// See UpdateDomain for more information on using the UpdateDomain +// API call, and error handling. +// +// This method is useful when you want to inject custom logic or configuration +// into the SDK's request lifecycle. Such as custom headers, or retry logic. +// +// +// // Example sending a request using the UpdateDomainRequest method. +// req, resp := client.UpdateDomainRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain +func (c *VoiceID) UpdateDomainRequest(input *UpdateDomainInput) (req *request.Request, output *UpdateDomainOutput) { + op := &request.Operation{ + Name: opUpdateDomain, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &UpdateDomainInput{} + } + + output = &UpdateDomainOutput{} + req = c.newRequest(op, input, output) + return +} + +// UpdateDomain API operation for Amazon Voice ID. +// +// Updates the specified domain. This API has clobber behavior, and clears and +// replaces all attributes. If an optional field, such as 'Description' is not +// provided, it is removed from the domain. +// +// Returns awserr.Error for service API and SDK errors. Use runtime type assertions +// with awserr.Error's Code and Message methods to get detailed information about +// the error. +// +// See the AWS API reference guide for Amazon Voice ID's +// API operation UpdateDomain for usage and error information. +// +// Returned Error Types: +// * ResourceNotFoundException +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +// +// * ValidationException +// The request failed one or more validations; check the error message for more +// details. +// +// * ConflictException +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +// +// * InternalServerException +// The request failed due to an unknown error on the server side. +// +// * ThrottlingException +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +// +// * AccessDeniedException +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27/UpdateDomain +func (c *VoiceID) UpdateDomain(input *UpdateDomainInput) (*UpdateDomainOutput, error) { + req, out := c.UpdateDomainRequest(input) + return out, req.Send() +} + +// UpdateDomainWithContext is the same as UpdateDomain with the addition of +// the ability to pass a context and additional request options. +// +// See UpdateDomain for details on how to use this API operation. +// +// The context must be non-nil and will be used for request cancellation. If +// the context is nil a panic will occur. In the future the SDK may create +// sub-contexts for http.Requests. See https://golang.org/pkg/context/ +// for more information on using Contexts. +func (c *VoiceID) UpdateDomainWithContext(ctx aws.Context, input *UpdateDomainInput, opts ...request.Option) (*UpdateDomainOutput, error) { + req, out := c.UpdateDomainRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +// You do not have sufficient permissions to perform this action. Check the +// error message and try again. +type AccessDeniedException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AccessDeniedException) GoString() string { + return s.String() +} + +func newErrorAccessDeniedException(v protocol.ResponseMetadata) error { + return &AccessDeniedException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *AccessDeniedException) Code() string { + return "AccessDeniedException" +} + +// Message returns the exception's message. +func (s *AccessDeniedException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *AccessDeniedException) OrigErr() error { + return nil +} + +func (s *AccessDeniedException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *AccessDeniedException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *AccessDeniedException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The configuration used to authenticate a speaker during a session. +type AuthenticationConfiguration struct { + _ struct{} `type:"structure"` + + // The minimum threshold needed to successfully authenticate a speaker. + // + // AcceptanceThreshold is a required field + AcceptanceThreshold *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AuthenticationConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AuthenticationConfiguration) GoString() string { + return s.String() +} + +// SetAcceptanceThreshold sets the AcceptanceThreshold field's value. +func (s *AuthenticationConfiguration) SetAcceptanceThreshold(v int64) *AuthenticationConfiguration { + s.AcceptanceThreshold = &v + return s +} + +// The authentication result produced by Voice ID, processed against the current +// session state and streamed audio of the speaker. +type AuthenticationResult struct { + _ struct{} `type:"structure"` + + // A timestamp indicating when audio aggregation ended for this authentication + // result. + AudioAggregationEndedAt *time.Time `type:"timestamp"` + + // A timestamp indicating when audio aggregation started for this authentication + // result. + AudioAggregationStartedAt *time.Time `type:"timestamp"` + + // The unique identifier for this authentication result. Because there can be + // multiple authentications for a given session, this field helps to identify + // if the returned result is from a previous streaming activity or a new result. + // Note that in absence of any new streaming activity, AcceptanceThreshold changes, + // or SpeakerId changes, Voice ID always returns cached Authentication Result + // for this API. + AuthenticationResultId *string `min:"22" type:"string"` + + // The AuthenticationConfiguration used to generate this authentication result. + Configuration *AuthenticationConfiguration `type:"structure"` + + // The client-provided identifier for the speaker whose authentication result + // is produced. Only present if a SpeakerId is provided for the session. + // + // CustomerSpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by AuthenticationResult's + // String and GoString methods. + CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"` + + // The authentication decision produced by Voice ID, processed against the current + // session state and streamed audio of the speaker. + Decision *string `type:"string" enum:"AuthenticationDecision"` + + // The service-generated identifier for the speaker whose authentication result + // is produced. + GeneratedSpeakerId *string `min:"25" type:"string"` + + // The authentication score for the speaker whose authentication result is produced. + // This value is only present if the authentication decision is either ACCEPT + // or REJECT. + Score *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AuthenticationResult) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s AuthenticationResult) GoString() string { + return s.String() +} + +// SetAudioAggregationEndedAt sets the AudioAggregationEndedAt field's value. +func (s *AuthenticationResult) SetAudioAggregationEndedAt(v time.Time) *AuthenticationResult { + s.AudioAggregationEndedAt = &v + return s +} + +// SetAudioAggregationStartedAt sets the AudioAggregationStartedAt field's value. +func (s *AuthenticationResult) SetAudioAggregationStartedAt(v time.Time) *AuthenticationResult { + s.AudioAggregationStartedAt = &v + return s +} + +// SetAuthenticationResultId sets the AuthenticationResultId field's value. +func (s *AuthenticationResult) SetAuthenticationResultId(v string) *AuthenticationResult { + s.AuthenticationResultId = &v + return s +} + +// SetConfiguration sets the Configuration field's value. +func (s *AuthenticationResult) SetConfiguration(v *AuthenticationConfiguration) *AuthenticationResult { + s.Configuration = v + return s +} + +// SetCustomerSpeakerId sets the CustomerSpeakerId field's value. +func (s *AuthenticationResult) SetCustomerSpeakerId(v string) *AuthenticationResult { + s.CustomerSpeakerId = &v + return s +} + +// SetDecision sets the Decision field's value. +func (s *AuthenticationResult) SetDecision(v string) *AuthenticationResult { + s.Decision = &v + return s +} + +// SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value. +func (s *AuthenticationResult) SetGeneratedSpeakerId(v string) *AuthenticationResult { + s.GeneratedSpeakerId = &v + return s +} + +// SetScore sets the Score field's value. +func (s *AuthenticationResult) SetScore(v int64) *AuthenticationResult { + s.Score = &v + return s +} + +// The request failed due to a conflict. Check the ConflictType and error message +// for more details. +type ConflictException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + // The type of conflict which caused a ConflictException. Possible types and + // the corresponding error messages are as follows: + // + // * DOMAIN_NOT_ACTIVE: The domain is not active. + // + // * CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT: You cannot change the speaker + // ID after an enrollment has been requested. + // + // * ENROLLMENT_ALREADY_EXISTS: There is already an enrollment for this session. + // + // * SPEAKER_NOT_SET: You must set the speaker ID before requesting an enrollment. + // + // * SPEAKER_OPTED_OUT: You cannot request an enrollment for an opted out + // speaker. + // + // * CONCURRENT_CHANGES: The request could not be processed as the resource + // was modified by another request during execution. + ConflictType *string `type:"string" enum:"ConflictType"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ConflictException) GoString() string { + return s.String() +} + +func newErrorConflictException(v protocol.ResponseMetadata) error { + return &ConflictException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ConflictException) Code() string { + return "ConflictException" +} + +// Message returns the exception's message. +func (s *ConflictException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ConflictException) OrigErr() error { + return nil +} + +func (s *ConflictException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ConflictException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ConflictException) RequestID() string { + return s.RespMetadata.RequestID +} + +type CreateDomainInput struct { + _ struct{} `type:"structure"` + + // The idempotency token for creating a new domain. If not provided, Amazon + // Web Services SDK populates this field. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // A brief description of this domain. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateDomainInput's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The name of the domain. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by CreateDomainInput's + // String and GoString methods. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // The configuration, containing the KMS Key Identifier, to be used by Voice + // ID for the server-side encryption of your data. Refer to Amazon Connect VoiceID + // encryption at rest (https://docs.aws.amazon.com/connect/latest/adminguide/encryption-at-rest.html#encryption-at-rest-voiceid) + // for more details on how the KMS Key is used. + // + // ServerSideEncryptionConfiguration is a required field + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"` + + // A list of tags you want added to the domain. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *CreateDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "CreateDomainInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ServerSideEncryptionConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ServerSideEncryptionConfiguration")) + } + if s.ServerSideEncryptionConfiguration != nil { + if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *CreateDomainInput) SetClientToken(v string) *CreateDomainInput { + s.ClientToken = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *CreateDomainInput) SetDescription(v string) *CreateDomainInput { + s.Description = &v + return s +} + +// SetName sets the Name field's value. +func (s *CreateDomainInput) SetName(v string) *CreateDomainInput { + s.Name = &v + return s +} + +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *CreateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *CreateDomainInput { + s.ServerSideEncryptionConfiguration = v + return s +} + +// SetTags sets the Tags field's value. +func (s *CreateDomainInput) SetTags(v []*Tag) *CreateDomainInput { + s.Tags = v + return s +} + +type CreateDomainOutput struct { + _ struct{} `type:"structure"` + + // Information about the newly created domain. + Domain *Domain `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s CreateDomainOutput) GoString() string { + return s.String() +} + +// SetDomain sets the Domain field's value. +func (s *CreateDomainOutput) SetDomain(v *Domain) *CreateDomainOutput { + s.Domain = v + return s +} + +type DeleteDomainInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain you want to delete. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDomainInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDomainInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteDomainInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DeleteDomainInput) SetDomainId(v string) *DeleteDomainInput { + s.DomainId = &v + return s +} + +type DeleteDomainOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDomainOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteDomainOutput) GoString() string { + return s.String() +} + +type DeleteFraudsterInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the fraudster. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the fraudster you want to delete. + // + // FraudsterId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DeleteFraudsterInput's + // String and GoString methods. + // + // FraudsterId is a required field + FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFraudsterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFraudsterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteFraudsterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteFraudsterInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.FraudsterId == nil { + invalidParams.Add(request.NewErrParamRequired("FraudsterId")) + } + if s.FraudsterId != nil && len(*s.FraudsterId) < 25 { + invalidParams.Add(request.NewErrParamMinLen("FraudsterId", 25)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DeleteFraudsterInput) SetDomainId(v string) *DeleteFraudsterInput { + s.DomainId = &v + return s +} + +// SetFraudsterId sets the FraudsterId field's value. +func (s *DeleteFraudsterInput) SetFraudsterId(v string) *DeleteFraudsterInput { + s.FraudsterId = &v + return s +} + +type DeleteFraudsterOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFraudsterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteFraudsterOutput) GoString() string { + return s.String() +} + +type DeleteSpeakerInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the speaker. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the speaker you want to delete. + // + // SpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DeleteSpeakerInput's + // String and GoString methods. + // + // SpeakerId is a required field + SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSpeakerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSpeakerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DeleteSpeakerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DeleteSpeakerInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.SpeakerId == nil { + invalidParams.Add(request.NewErrParamRequired("SpeakerId")) + } + if s.SpeakerId != nil && len(*s.SpeakerId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SpeakerId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DeleteSpeakerInput) SetDomainId(v string) *DeleteSpeakerInput { + s.DomainId = &v + return s +} + +// SetSpeakerId sets the SpeakerId field's value. +func (s *DeleteSpeakerInput) SetSpeakerId(v string) *DeleteSpeakerInput { + s.SpeakerId = &v + return s +} + +type DeleteSpeakerOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSpeakerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DeleteSpeakerOutput) GoString() string { + return s.String() +} + +type DescribeDomainInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain you are describing. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDomainInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDomainInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeDomainInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeDomainInput) SetDomainId(v string) *DescribeDomainInput { + s.DomainId = &v + return s +} + +type DescribeDomainOutput struct { + _ struct{} `type:"structure"` + + // Information about the specified domain. + Domain *Domain `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDomainOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeDomainOutput) GoString() string { + return s.String() +} + +// SetDomain sets the Domain field's value. +func (s *DescribeDomainOutput) SetDomain(v *Domain) *DescribeDomainOutput { + s.Domain = v + return s +} + +type DescribeFraudsterInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the fraudster. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the fraudster you are describing. + // + // FraudsterId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribeFraudsterInput's + // String and GoString methods. + // + // FraudsterId is a required field + FraudsterId *string `min:"25" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFraudsterInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFraudsterInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.FraudsterId == nil { + invalidParams.Add(request.NewErrParamRequired("FraudsterId")) + } + if s.FraudsterId != nil && len(*s.FraudsterId) < 25 { + invalidParams.Add(request.NewErrParamMinLen("FraudsterId", 25)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeFraudsterInput) SetDomainId(v string) *DescribeFraudsterInput { + s.DomainId = &v + return s +} + +// SetFraudsterId sets the FraudsterId field's value. +func (s *DescribeFraudsterInput) SetFraudsterId(v string) *DescribeFraudsterInput { + s.FraudsterId = &v + return s +} + +type DescribeFraudsterOutput struct { + _ struct{} `type:"structure"` + + // Information about the specified fraudster. + Fraudster *Fraudster `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterOutput) GoString() string { + return s.String() +} + +// SetFraudster sets the Fraudster field's value. +func (s *DescribeFraudsterOutput) SetFraudster(v *Fraudster) *DescribeFraudsterOutput { + s.Fraudster = v + return s +} + +type DescribeFraudsterRegistrationJobInput struct { + _ struct{} `type:"structure"` + + // The identifier for the domain containing the fraudster registration job. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier for the fraudster registration job you are describing. + // + // JobId is a required field + JobId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterRegistrationJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterRegistrationJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeFraudsterRegistrationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeFraudsterRegistrationJobInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeFraudsterRegistrationJobInput) SetDomainId(v string) *DescribeFraudsterRegistrationJobInput { + s.DomainId = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DescribeFraudsterRegistrationJobInput) SetJobId(v string) *DescribeFraudsterRegistrationJobInput { + s.JobId = &v + return s +} + +type DescribeFraudsterRegistrationJobOutput struct { + _ struct{} `type:"structure"` + + // Contains details about the specified fraudster registration job. + Job *FraudsterRegistrationJob `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterRegistrationJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeFraudsterRegistrationJobOutput) GoString() string { + return s.String() +} + +// SetJob sets the Job field's value. +func (s *DescribeFraudsterRegistrationJobOutput) SetJob(v *FraudsterRegistrationJob) *DescribeFraudsterRegistrationJobOutput { + s.Job = v + return s +} + +type DescribeSpeakerEnrollmentJobInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the speaker enrollment job. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the speaker enrollment job you are describing. + // + // JobId is a required field + JobId *string `min:"22" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerEnrollmentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerEnrollmentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeSpeakerEnrollmentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSpeakerEnrollmentJobInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 22)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeSpeakerEnrollmentJobInput) SetDomainId(v string) *DescribeSpeakerEnrollmentJobInput { + s.DomainId = &v + return s +} + +// SetJobId sets the JobId field's value. +func (s *DescribeSpeakerEnrollmentJobInput) SetJobId(v string) *DescribeSpeakerEnrollmentJobInput { + s.JobId = &v + return s +} + +type DescribeSpeakerEnrollmentJobOutput struct { + _ struct{} `type:"structure"` + + // Contains details about the specified speaker enrollment job. + Job *SpeakerEnrollmentJob `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerEnrollmentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerEnrollmentJobOutput) GoString() string { + return s.String() +} + +// SetJob sets the Job field's value. +func (s *DescribeSpeakerEnrollmentJobOutput) SetJob(v *SpeakerEnrollmentJob) *DescribeSpeakerEnrollmentJobOutput { + s.Job = v + return s +} + +type DescribeSpeakerInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain that contains the speaker. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the speaker you are describing. + // + // SpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DescribeSpeakerInput's + // String and GoString methods. + // + // SpeakerId is a required field + SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribeSpeakerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribeSpeakerInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.SpeakerId == nil { + invalidParams.Add(request.NewErrParamRequired("SpeakerId")) + } + if s.SpeakerId != nil && len(*s.SpeakerId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SpeakerId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *DescribeSpeakerInput) SetDomainId(v string) *DescribeSpeakerInput { + s.DomainId = &v + return s +} + +// SetSpeakerId sets the SpeakerId field's value. +func (s *DescribeSpeakerInput) SetSpeakerId(v string) *DescribeSpeakerInput { + s.SpeakerId = &v + return s +} + +type DescribeSpeakerOutput struct { + _ struct{} `type:"structure"` + + // Information about the specified speaker. + Speaker *Speaker `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DescribeSpeakerOutput) GoString() string { + return s.String() +} + +// SetSpeaker sets the Speaker field's value. +func (s *DescribeSpeakerOutput) SetSpeaker(v *Speaker) *DescribeSpeakerOutput { + s.Speaker = v + return s +} + +// Contains all the information about a domain. +type Domain struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the domain. + Arn *string `type:"string"` + + // The timestamp at which the domain is created. + CreatedAt *time.Time `type:"timestamp"` + + // The client-provided description of the domain. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Domain's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The service-generated identifier for the domain. + DomainId *string `min:"22" type:"string"` + + // The current status of the domain. + DomainStatus *string `type:"string" enum:"DomainStatus"` + + // The client-provided name for the domain. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Domain's + // String and GoString methods. + Name *string `min:"1" type:"string" sensitive:"true"` + + // The server-side encryption configuration containing the KMS Key Identifier + // you want Voice ID to use to encrypt your data. + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` + + // The timestamp showing the domain's last update. + UpdatedAt *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Domain) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Domain) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *Domain) SetArn(v string) *Domain { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Domain) SetCreatedAt(v time.Time) *Domain { + s.CreatedAt = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *Domain) SetDescription(v string) *Domain { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *Domain) SetDomainId(v string) *Domain { + s.DomainId = &v + return s +} + +// SetDomainStatus sets the DomainStatus field's value. +func (s *Domain) SetDomainStatus(v string) *Domain { + s.DomainStatus = &v + return s +} + +// SetName sets the Name field's value. +func (s *Domain) SetName(v string) *Domain { + s.Name = &v + return s +} + +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *Domain) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *Domain { + s.ServerSideEncryptionConfiguration = v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *Domain) SetUpdatedAt(v time.Time) *Domain { + s.UpdatedAt = &v + return s +} + +// Contains a summary of information about a domain. +type DomainSummary struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) for the domain. + Arn *string `type:"string"` + + // The timestamp showing when the domain is created. + CreatedAt *time.Time `type:"timestamp"` + + // The client-provided description of the domain. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DomainSummary's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The service-generated identifier for the domain. + DomainId *string `min:"22" type:"string"` + + // The current status of the domain. + DomainStatus *string `type:"string" enum:"DomainStatus"` + + // The client-provided name for the domain. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by DomainSummary's + // String and GoString methods. + Name *string `min:"1" type:"string" sensitive:"true"` + + // The server-side encryption configuration containing the KMS Key Identifier + // you want Voice ID to use to encrypt your data.. + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure"` + + // The timestamp showing the domain's last update. + UpdatedAt *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DomainSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s DomainSummary) GoString() string { + return s.String() +} + +// SetArn sets the Arn field's value. +func (s *DomainSummary) SetArn(v string) *DomainSummary { + s.Arn = &v + return s +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *DomainSummary) SetCreatedAt(v time.Time) *DomainSummary { + s.CreatedAt = &v + return s +} + +// SetDescription sets the Description field's value. +func (s *DomainSummary) SetDescription(v string) *DomainSummary { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *DomainSummary) SetDomainId(v string) *DomainSummary { + s.DomainId = &v + return s +} + +// SetDomainStatus sets the DomainStatus field's value. +func (s *DomainSummary) SetDomainStatus(v string) *DomainSummary { + s.DomainStatus = &v + return s +} + +// SetName sets the Name field's value. +func (s *DomainSummary) SetName(v string) *DomainSummary { + s.Name = &v + return s +} + +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *DomainSummary) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *DomainSummary { + s.ServerSideEncryptionConfiguration = v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *DomainSummary) SetUpdatedAt(v time.Time) *DomainSummary { + s.UpdatedAt = &v + return s +} + +// Contains configurations defining enrollment behavior for the batch job. +type EnrollmentConfig struct { + _ struct{} `type:"structure"` + + // The action to take when the specified speaker is already enrolled in the + // specified domain. The default value is SKIP, which skips the enrollment for + // the existing speaker. Setting the value to OVERWRITE replaces the existing + // voice prints and enrollment audio stored for that speaker with new data generated + // from the latest audio. + ExistingEnrollmentAction *string `type:"string" enum:"ExistingEnrollmentAction"` + + // The fraud detection configuration to use for the speaker enrollment job. + FraudDetectionConfig *EnrollmentJobFraudDetectionConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnrollmentConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnrollmentConfig) GoString() string { + return s.String() +} + +// SetExistingEnrollmentAction sets the ExistingEnrollmentAction field's value. +func (s *EnrollmentConfig) SetExistingEnrollmentAction(v string) *EnrollmentConfig { + s.ExistingEnrollmentAction = &v + return s +} + +// SetFraudDetectionConfig sets the FraudDetectionConfig field's value. +func (s *EnrollmentConfig) SetFraudDetectionConfig(v *EnrollmentJobFraudDetectionConfig) *EnrollmentConfig { + s.FraudDetectionConfig = v + return s +} + +// The configuration defining the action to take when a speaker is flagged by +// the fraud detection system during a batch speaker enrollment job, and the +// risk threshold to use for identification. +type EnrollmentJobFraudDetectionConfig struct { + _ struct{} `type:"structure"` + + // The action to take when the given speaker is flagged by the fraud detection + // system. The default value is FAIL, which fails the speaker enrollment. Changing + // this value to IGNORE results in the speaker being enrolled even if they are + // flagged by the fraud detection system. + FraudDetectionAction *string `type:"string" enum:"FraudDetectionAction"` + + // Threshold value for determining whether the speaker is a high risk to be + // fraudulent. If the detected risk score calculated by Voice ID is greater + // than or equal to the threshold, the speaker is considered a fraudster. + RiskThreshold *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnrollmentJobFraudDetectionConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EnrollmentJobFraudDetectionConfig) GoString() string { + return s.String() +} + +// SetFraudDetectionAction sets the FraudDetectionAction field's value. +func (s *EnrollmentJobFraudDetectionConfig) SetFraudDetectionAction(v string) *EnrollmentJobFraudDetectionConfig { + s.FraudDetectionAction = &v + return s +} + +// SetRiskThreshold sets the RiskThreshold field's value. +func (s *EnrollmentJobFraudDetectionConfig) SetRiskThreshold(v int64) *EnrollmentJobFraudDetectionConfig { + s.RiskThreshold = &v + return s +} + +type EvaluateSessionInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain where the session started. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The session identifier, or name of the session, that you want to evaluate. + // In Voice ID integration, this is the Contact-Id. + // + // SessionNameOrId is a required field + SessionNameOrId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluateSessionInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluateSessionInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *EvaluateSessionInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "EvaluateSessionInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.SessionNameOrId == nil { + invalidParams.Add(request.NewErrParamRequired("SessionNameOrId")) + } + if s.SessionNameOrId != nil && len(*s.SessionNameOrId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SessionNameOrId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *EvaluateSessionInput) SetDomainId(v string) *EvaluateSessionInput { + s.DomainId = &v + return s +} + +// SetSessionNameOrId sets the SessionNameOrId field's value. +func (s *EvaluateSessionInput) SetSessionNameOrId(v string) *EvaluateSessionInput { + s.SessionNameOrId = &v + return s +} + +type EvaluateSessionOutput struct { + _ struct{} `type:"structure"` + + // Details resulting from the authentication process, such as authentication + // decision and authentication score. + AuthenticationResult *AuthenticationResult `type:"structure"` + + // The identifier of the domain containing the session. + DomainId *string `min:"22" type:"string"` + + // Details resulting from the fraud detection process, such as fraud detection + // decision and risk score. + FraudDetectionResult *FraudDetectionResult `type:"structure"` + + // The service-generated identifier of the session. + SessionId *string `min:"25" type:"string"` + + // The client-provided name of the session. + SessionName *string `min:"1" type:"string"` + + // The current status of audio streaming for this session. This field is useful + // to infer next steps when the Authentication or Fraud Detection results are + // empty or the decision is NOT_ENOUGH_SPEECH. In this situation, if the StreamingStatus + // is ONGOING/PENDING_CONFIGURATION, it can mean that the client should call + // the API again later, once Voice ID has enough audio to produce a result. + // If the decision remains NOT_ENOUGH_SPEECH even after StreamingStatus is ENDED, + // it means that the previously streamed session did not have enough speech + // to perform evaluation, and a new streaming session is needed to try again. + StreamingStatus *string `type:"string" enum:"StreamingStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluateSessionOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s EvaluateSessionOutput) GoString() string { + return s.String() +} + +// SetAuthenticationResult sets the AuthenticationResult field's value. +func (s *EvaluateSessionOutput) SetAuthenticationResult(v *AuthenticationResult) *EvaluateSessionOutput { + s.AuthenticationResult = v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *EvaluateSessionOutput) SetDomainId(v string) *EvaluateSessionOutput { + s.DomainId = &v + return s +} + +// SetFraudDetectionResult sets the FraudDetectionResult field's value. +func (s *EvaluateSessionOutput) SetFraudDetectionResult(v *FraudDetectionResult) *EvaluateSessionOutput { + s.FraudDetectionResult = v + return s +} + +// SetSessionId sets the SessionId field's value. +func (s *EvaluateSessionOutput) SetSessionId(v string) *EvaluateSessionOutput { + s.SessionId = &v + return s +} + +// SetSessionName sets the SessionName field's value. +func (s *EvaluateSessionOutput) SetSessionName(v string) *EvaluateSessionOutput { + s.SessionName = &v + return s +} + +// SetStreamingStatus sets the StreamingStatus field's value. +func (s *EvaluateSessionOutput) SetStreamingStatus(v string) *EvaluateSessionOutput { + s.StreamingStatus = &v + return s +} + +// Contains error details for a failed batch job. +type FailureDetails struct { + _ struct{} `type:"structure"` + + // A description of the error that caused the batch job failure. + Message *string `min:"1" type:"string"` + + // An HTTP status code representing the nature of the error. + StatusCode *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailureDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FailureDetails) GoString() string { + return s.String() +} + +// SetMessage sets the Message field's value. +func (s *FailureDetails) SetMessage(v string) *FailureDetails { + s.Message = &v + return s +} + +// SetStatusCode sets the StatusCode field's value. +func (s *FailureDetails) SetStatusCode(v int64) *FailureDetails { + s.StatusCode = &v + return s +} + +// The configuration used for performing fraud detection over a speaker during +// a session. +type FraudDetectionConfiguration struct { + _ struct{} `type:"structure"` + + // Threshold value for determining whether the speaker is a fraudster. If the + // detected risk score calculated by Voice ID is higher than the threshold, + // the speaker is considered a fraudster. + // + // RiskThreshold is a required field + RiskThreshold *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudDetectionConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudDetectionConfiguration) GoString() string { + return s.String() +} + +// SetRiskThreshold sets the RiskThreshold field's value. +func (s *FraudDetectionConfiguration) SetRiskThreshold(v int64) *FraudDetectionConfiguration { + s.RiskThreshold = &v + return s +} + +// The fraud detection result produced by Voice ID, processed against the current +// session state and streamed audio of the speaker. +type FraudDetectionResult struct { + _ struct{} `type:"structure"` + + // A timestamp indicating when audio aggregation ended for this fraud detection + // result. + AudioAggregationEndedAt *time.Time `type:"timestamp"` + + // A timestamp indicating when audio aggregation started for this fraud detection + // result. + AudioAggregationStartedAt *time.Time `type:"timestamp"` + + // The FraudDetectionConfiguration used to generate this fraud detection result. + Configuration *FraudDetectionConfiguration `type:"structure"` + + // The fraud detection decision produced by Voice ID, processed against the + // current session state and streamed audio of the speaker. + Decision *string `type:"string" enum:"FraudDetectionDecision"` + + // The unique identifier for this fraud detection result. Given there can be + // multiple fraud detections for a given session, this field helps in identifying + // if the returned result is from previous streaming activity or a new result. + // Note that in the absence of any new streaming activity or risk threshold + // changes, Voice ID always returns cached Fraud Detection result for this API. + FraudDetectionResultId *string `min:"22" type:"string"` + + // The reason speaker was flagged by the fraud detection system. This is only + // be populated if fraud detection Decision is HIGH_RISK, and only has one possible + // value: KNOWN_FRAUDSTER. + Reasons []*string `type:"list"` + + // Details about each risk analyzed for this speaker. + RiskDetails *FraudRiskDetails `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudDetectionResult) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudDetectionResult) GoString() string { + return s.String() +} + +// SetAudioAggregationEndedAt sets the AudioAggregationEndedAt field's value. +func (s *FraudDetectionResult) SetAudioAggregationEndedAt(v time.Time) *FraudDetectionResult { + s.AudioAggregationEndedAt = &v + return s +} + +// SetAudioAggregationStartedAt sets the AudioAggregationStartedAt field's value. +func (s *FraudDetectionResult) SetAudioAggregationStartedAt(v time.Time) *FraudDetectionResult { + s.AudioAggregationStartedAt = &v + return s +} + +// SetConfiguration sets the Configuration field's value. +func (s *FraudDetectionResult) SetConfiguration(v *FraudDetectionConfiguration) *FraudDetectionResult { + s.Configuration = v + return s +} + +// SetDecision sets the Decision field's value. +func (s *FraudDetectionResult) SetDecision(v string) *FraudDetectionResult { + s.Decision = &v + return s +} + +// SetFraudDetectionResultId sets the FraudDetectionResultId field's value. +func (s *FraudDetectionResult) SetFraudDetectionResultId(v string) *FraudDetectionResult { + s.FraudDetectionResultId = &v + return s +} + +// SetReasons sets the Reasons field's value. +func (s *FraudDetectionResult) SetReasons(v []*string) *FraudDetectionResult { + s.Reasons = v + return s +} + +// SetRiskDetails sets the RiskDetails field's value. +func (s *FraudDetectionResult) SetRiskDetails(v *FraudRiskDetails) *FraudDetectionResult { + s.RiskDetails = v + return s +} + +// Details regarding various fraud risk analyses performed against the current +// session state and streamed audio of the speaker. +type FraudRiskDetails struct { + _ struct{} `type:"structure"` + + // The details resulting from 'Known Fraudster Risk' analysis of the speaker. + // + // KnownFraudsterRisk is a required field + KnownFraudsterRisk *KnownFraudsterRisk `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudRiskDetails) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudRiskDetails) GoString() string { + return s.String() +} + +// SetKnownFraudsterRisk sets the KnownFraudsterRisk field's value. +func (s *FraudRiskDetails) SetKnownFraudsterRisk(v *KnownFraudsterRisk) *FraudRiskDetails { + s.KnownFraudsterRisk = v + return s +} + +// Contains all the information about a fraudster. +type Fraudster struct { + _ struct{} `type:"structure"` + + // The timestamp when Voice ID identified the fraudster. + CreatedAt *time.Time `type:"timestamp"` + + // The identifier for the domain containing the fraudster. + DomainId *string `min:"22" type:"string"` + + // The service-generated identifier for the fraudster. + GeneratedFraudsterId *string `min:"25" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Fraudster) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Fraudster) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Fraudster) SetCreatedAt(v time.Time) *Fraudster { + s.CreatedAt = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *Fraudster) SetDomainId(v string) *Fraudster { + s.DomainId = &v + return s +} + +// SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value. +func (s *Fraudster) SetGeneratedFraudsterId(v string) *Fraudster { + s.GeneratedFraudsterId = &v + return s +} + +// Contains all the information about a fraudster registration job. +type FraudsterRegistrationJob struct { + _ struct{} `type:"structure"` + + // A timestamp showing the creation time of the fraudster registration job. + CreatedAt *time.Time `type:"timestamp"` + + // 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. + DataAccessRoleArn *string `min:"20" type:"string"` + + // The identifier of the domain containing the fraudster registration job. + DomainId *string `min:"22" type:"string"` + + // A timestamp showing when the fraudster registration job ended. + EndedAt *time.Time `type:"timestamp"` + + // Contains details that are populated when an entire batch job fails. In cases + // of individual registration job failures, the batch job as a whole doesn't + // fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can + // use the job output file to identify the individual registration requests + // that failed. + FailureDetails *FailureDetails `type:"structure"` + + // The input data config containing an S3 URI for the input manifest file that + // contains the list of fraudster registration job requests. + InputDataConfig *InputDataConfig `type:"structure"` + + // The service-generated identifier for the fraudster registration job. + JobId *string `min:"22" type:"string"` + + // The client-provied name for the fraudster registration job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by FraudsterRegistrationJob's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // Shows the completed percentage of registration requests listed in the input + // file. + JobProgress *JobProgress `type:"structure"` + + // The current status of the fraudster registration job. + JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"` + + // 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. + OutputDataConfig *OutputDataConfig `type:"structure"` + + // 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. + RegistrationConfig *RegistrationConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterRegistrationJob) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterRegistrationJob) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *FraudsterRegistrationJob) SetCreatedAt(v time.Time) *FraudsterRegistrationJob { + s.CreatedAt = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *FraudsterRegistrationJob) SetDataAccessRoleArn(v string) *FraudsterRegistrationJob { + s.DataAccessRoleArn = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *FraudsterRegistrationJob) SetDomainId(v string) *FraudsterRegistrationJob { + s.DomainId = &v + return s +} + +// SetEndedAt sets the EndedAt field's value. +func (s *FraudsterRegistrationJob) SetEndedAt(v time.Time) *FraudsterRegistrationJob { + s.EndedAt = &v + return s +} + +// SetFailureDetails sets the FailureDetails field's value. +func (s *FraudsterRegistrationJob) SetFailureDetails(v *FailureDetails) *FraudsterRegistrationJob { + s.FailureDetails = v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *FraudsterRegistrationJob) SetInputDataConfig(v *InputDataConfig) *FraudsterRegistrationJob { + s.InputDataConfig = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *FraudsterRegistrationJob) SetJobId(v string) *FraudsterRegistrationJob { + s.JobId = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *FraudsterRegistrationJob) SetJobName(v string) *FraudsterRegistrationJob { + s.JobName = &v + return s +} + +// SetJobProgress sets the JobProgress field's value. +func (s *FraudsterRegistrationJob) SetJobProgress(v *JobProgress) *FraudsterRegistrationJob { + s.JobProgress = v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *FraudsterRegistrationJob) SetJobStatus(v string) *FraudsterRegistrationJob { + s.JobStatus = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *FraudsterRegistrationJob) SetOutputDataConfig(v *OutputDataConfig) *FraudsterRegistrationJob { + s.OutputDataConfig = v + return s +} + +// SetRegistrationConfig sets the RegistrationConfig field's value. +func (s *FraudsterRegistrationJob) SetRegistrationConfig(v *RegistrationConfig) *FraudsterRegistrationJob { + s.RegistrationConfig = v + return s +} + +// Contains a summary of information about a fraudster registration job. +type FraudsterRegistrationJobSummary struct { + _ struct{} `type:"structure"` + + // A timestamp showing when the fraudster registration job is created. + CreatedAt *time.Time `type:"timestamp"` + + // The identifier of the domain containing the fraudster registration job. + DomainId *string `min:"22" type:"string"` + + // A timestamp showing when the fraudster registration job ended. + EndedAt *time.Time `type:"timestamp"` + + // Contains details that are populated when an entire batch job fails. In cases + // of individual registration job failures, the batch job as a whole doesn't + // fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can + // use the job output file to identify the individual registration requests + // that failed. + FailureDetails *FailureDetails `type:"structure"` + + // The service-generated identifier for the fraudster registration job. + JobId *string `min:"22" type:"string"` + + // The client-provied name for the fraudster registration job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by FraudsterRegistrationJobSummary's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // Shows the completed percentage of registration requests listed in the input + // file. + JobProgress *JobProgress `type:"structure"` + + // The current status of the fraudster registration job. + JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterRegistrationJobSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s FraudsterRegistrationJobSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *FraudsterRegistrationJobSummary) SetCreatedAt(v time.Time) *FraudsterRegistrationJobSummary { + s.CreatedAt = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *FraudsterRegistrationJobSummary) SetDomainId(v string) *FraudsterRegistrationJobSummary { + s.DomainId = &v + return s +} + +// SetEndedAt sets the EndedAt field's value. +func (s *FraudsterRegistrationJobSummary) SetEndedAt(v time.Time) *FraudsterRegistrationJobSummary { + s.EndedAt = &v + return s +} + +// SetFailureDetails sets the FailureDetails field's value. +func (s *FraudsterRegistrationJobSummary) SetFailureDetails(v *FailureDetails) *FraudsterRegistrationJobSummary { + s.FailureDetails = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *FraudsterRegistrationJobSummary) SetJobId(v string) *FraudsterRegistrationJobSummary { + s.JobId = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *FraudsterRegistrationJobSummary) SetJobName(v string) *FraudsterRegistrationJobSummary { + s.JobName = &v + return s +} + +// SetJobProgress sets the JobProgress field's value. +func (s *FraudsterRegistrationJobSummary) SetJobProgress(v *JobProgress) *FraudsterRegistrationJobSummary { + s.JobProgress = v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *FraudsterRegistrationJobSummary) SetJobStatus(v string) *FraudsterRegistrationJobSummary { + s.JobStatus = &v + return s +} + +// The configuration containing input file information for a batch job. +type InputDataConfig struct { + _ struct{} `type:"structure"` + + // The S3 location for the input manifest file that contains the list of individual + // enrollment or registration job requests. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InputDataConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InputDataConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *InputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "InputDataConfig"} + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetS3Uri sets the S3Uri field's value. +func (s *InputDataConfig) SetS3Uri(v string) *InputDataConfig { + s.S3Uri = &v + return s +} + +// The request failed due to an unknown error on the server side. +type InternalServerException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s InternalServerException) GoString() string { + return s.String() +} + +func newErrorInternalServerException(v protocol.ResponseMetadata) error { + return &InternalServerException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *InternalServerException) Code() string { + return "InternalServerException" +} + +// Message returns the exception's message. +func (s *InternalServerException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *InternalServerException) OrigErr() error { + return nil +} + +func (s *InternalServerException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *InternalServerException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *InternalServerException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Indicates the completion progress for a batch job. +type JobProgress struct { + _ struct{} `type:"structure"` + + // Shows the completed percentage of enrollment or registration requests listed + // in the input file. + PercentComplete *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JobProgress) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s JobProgress) GoString() string { + return s.String() +} + +// SetPercentComplete sets the PercentComplete field's value. +func (s *JobProgress) SetPercentComplete(v int64) *JobProgress { + s.PercentComplete = &v + return s +} + +// Contains details produced as a result of performing known fraudster risk +// analysis on a speaker. +type KnownFraudsterRisk struct { + _ struct{} `type:"structure"` + + // The identifier of the fraudster that is the closest match to the speaker. + // If there are no fraudsters registered in a given domain, or if there are + // no fraudsters with a non-zero RiskScore, this value is null. + GeneratedFraudsterId *string `min:"25" type:"string"` + + // The score indicating the likelihood the speaker is a known fraudster. + // + // RiskScore is a required field + RiskScore *int64 `type:"integer" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KnownFraudsterRisk) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s KnownFraudsterRisk) GoString() string { + return s.String() +} + +// SetGeneratedFraudsterId sets the GeneratedFraudsterId field's value. +func (s *KnownFraudsterRisk) SetGeneratedFraudsterId(v string) *KnownFraudsterRisk { + s.GeneratedFraudsterId = &v + return s +} + +// SetRiskScore sets the RiskScore field's value. +func (s *KnownFraudsterRisk) SetRiskScore(v int64) *KnownFraudsterRisk { + s.RiskScore = &v + return s +} + +type ListDomainsInput struct { + _ struct{} `type:"structure"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain further pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDomainsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDomainsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListDomainsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListDomainsInput"} + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListDomainsInput) SetMaxResults(v int64) *ListDomainsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDomainsInput) SetNextToken(v string) *ListDomainsInput { + s.NextToken = &v + return s +} + +type ListDomainsOutput struct { + _ struct{} `type:"structure"` + + // A list containing details about each domain in the Amazon Web Services account. + DomainSummaries []*DomainSummary `type:"list"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDomainsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListDomainsOutput) GoString() string { + return s.String() +} + +// SetDomainSummaries sets the DomainSummaries field's value. +func (s *ListDomainsOutput) SetDomainSummaries(v []*DomainSummary) *ListDomainsOutput { + s.DomainSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListDomainsOutput) SetNextToken(v string) *ListDomainsOutput { + s.NextToken = &v + return s +} + +type ListFraudsterRegistrationJobsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the fraudster registration Jobs. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // Provides the status of your fraudster registration job. + JobStatus *string `type:"string" enum:"FraudsterRegistrationJobStatus"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain further pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListFraudsterRegistrationJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListFraudsterRegistrationJobsInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *ListFraudsterRegistrationJobsInput) SetDomainId(v string) *ListFraudsterRegistrationJobsInput { + s.DomainId = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *ListFraudsterRegistrationJobsInput) SetJobStatus(v string) *ListFraudsterRegistrationJobsInput { + s.JobStatus = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListFraudsterRegistrationJobsInput) SetMaxResults(v int64) *ListFraudsterRegistrationJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFraudsterRegistrationJobsInput) SetNextToken(v string) *ListFraudsterRegistrationJobsInput { + s.NextToken = &v + return s +} + +type ListFraudsterRegistrationJobsOutput struct { + _ struct{} `type:"structure"` + + // A list containing details about each specified fraudster registration job. + JobSummaries []*FraudsterRegistrationJobSummary `type:"list"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListFraudsterRegistrationJobsOutput) GoString() string { + return s.String() +} + +// SetJobSummaries sets the JobSummaries field's value. +func (s *ListFraudsterRegistrationJobsOutput) SetJobSummaries(v []*FraudsterRegistrationJobSummary) *ListFraudsterRegistrationJobsOutput { + s.JobSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListFraudsterRegistrationJobsOutput) SetNextToken(v string) *ListFraudsterRegistrationJobsOutput { + s.NextToken = &v + return s +} + +type ListSpeakerEnrollmentJobsInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the speaker enrollment jobs. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // Provides the status of your speaker enrollment Job. + JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain further pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakerEnrollmentJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakerEnrollmentJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSpeakerEnrollmentJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSpeakerEnrollmentJobsInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *ListSpeakerEnrollmentJobsInput) SetDomainId(v string) *ListSpeakerEnrollmentJobsInput { + s.DomainId = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *ListSpeakerEnrollmentJobsInput) SetJobStatus(v string) *ListSpeakerEnrollmentJobsInput { + s.JobStatus = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSpeakerEnrollmentJobsInput) SetMaxResults(v int64) *ListSpeakerEnrollmentJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSpeakerEnrollmentJobsInput) SetNextToken(v string) *ListSpeakerEnrollmentJobsInput { + s.NextToken = &v + return s +} + +type ListSpeakerEnrollmentJobsOutput struct { + _ struct{} `type:"structure"` + + // A list containing details about each specified speaker enrollment job. + JobSummaries []*SpeakerEnrollmentJobSummary `type:"list"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakerEnrollmentJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakerEnrollmentJobsOutput) GoString() string { + return s.String() +} + +// SetJobSummaries sets the JobSummaries field's value. +func (s *ListSpeakerEnrollmentJobsOutput) SetJobSummaries(v []*SpeakerEnrollmentJobSummary) *ListSpeakerEnrollmentJobsOutput { + s.JobSummaries = v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSpeakerEnrollmentJobsOutput) SetNextToken(v string) *ListSpeakerEnrollmentJobsOutput { + s.NextToken = &v + return s +} + +type ListSpeakersInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The maximum number of results that are returned per call. You can use NextToken + // to obtain further pages of results. The default is 100; the maximum allowed + // page size is also 100. + MaxResults *int64 `min:"1" type:"integer"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakersInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakersInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListSpeakersInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListSpeakersInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.MaxResults != nil && *s.MaxResults < 1 { + invalidParams.Add(request.NewErrParamMinValue("MaxResults", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *ListSpeakersInput) SetDomainId(v string) *ListSpeakersInput { + s.DomainId = &v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListSpeakersInput) SetMaxResults(v int64) *ListSpeakersInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSpeakersInput) SetNextToken(v string) *ListSpeakersInput { + s.NextToken = &v + return s +} + +type ListSpeakersOutput struct { + _ struct{} `type:"structure"` + + // If NextToken is returned, there are more results available. The value of + // NextToken is a unique pagination token for each page. Make the call again + // using the returned token to retrieve the next page. Keep all other arguments + // unchanged. Each pagination token expires after 24 hours. + NextToken *string `min:"1" type:"string"` + + // A list containing details about each speaker in the Amazon Web Services account. + SpeakerSummaries []*SpeakerSummary `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakersOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListSpeakersOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListSpeakersOutput) SetNextToken(v string) *ListSpeakersOutput { + s.NextToken = &v + return s +} + +// SetSpeakerSummaries sets the SpeakerSummaries field's value. +func (s *ListSpeakersOutput) SetSpeakerSummaries(v []*SpeakerSummary) *ListSpeakersOutput { + s.SpeakerSummaries = v + return s +} + +type ListTagsForResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Voice ID resource for which you want + // to list the tags. + // + // ResourceArn is a required field + ResourceArn *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListTagsForResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListTagsForResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput { + s.ResourceArn = &v + return s +} + +type ListTagsForResourceOutput struct { + _ struct{} `type:"structure"` + + // The list of tags associated with the specified resource. + Tags []*Tag `type:"list"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ListTagsForResourceOutput) GoString() string { + return s.String() +} + +// SetTags sets the Tags field's value. +func (s *ListTagsForResourceOutput) SetTags(v []*Tag) *ListTagsForResourceOutput { + s.Tags = v + return s +} + +type OptOutSpeakerInput struct { + _ struct{} `type:"structure"` + + // The identifier of the domain containing the speaker. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The identifier of the speaker you want opted-out. + // + // SpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by OptOutSpeakerInput's + // String and GoString methods. + // + // SpeakerId is a required field + SpeakerId *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptOutSpeakerInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptOutSpeakerInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OptOutSpeakerInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OptOutSpeakerInput"} + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.SpeakerId == nil { + invalidParams.Add(request.NewErrParamRequired("SpeakerId")) + } + if s.SpeakerId != nil && len(*s.SpeakerId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("SpeakerId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDomainId sets the DomainId field's value. +func (s *OptOutSpeakerInput) SetDomainId(v string) *OptOutSpeakerInput { + s.DomainId = &v + return s +} + +// SetSpeakerId sets the SpeakerId field's value. +func (s *OptOutSpeakerInput) SetSpeakerId(v string) *OptOutSpeakerInput { + s.SpeakerId = &v + return s +} + +type OptOutSpeakerOutput struct { + _ struct{} `type:"structure"` + + // Details about the opted-out speaker. + Speaker *Speaker `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptOutSpeakerOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OptOutSpeakerOutput) GoString() string { + return s.String() +} + +// SetSpeaker sets the Speaker field's value. +func (s *OptOutSpeakerOutput) SetSpeaker(v *Speaker) *OptOutSpeakerOutput { + s.Speaker = v + return s +} + +// The configuration containing output file information for a batch job. +type OutputDataConfig struct { + _ struct{} `type:"structure"` + + // the identifier of the KMS key you want Voice ID to use to encrypt the output + // file of the fraudster registration job. + KmsKeyId *string `min:"1" type:"string"` + + // The S3 path of the folder to which Voice ID writes the job output file, which + // has a *.out extension. For example, if the input file name is input-file.json + // and the output folder path is s3://output-bucket/output-folder, the full + // output file path is s3://output-bucket/output-folder/job-Id/input-file.json.out. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OutputDataConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s OutputDataConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *OutputDataConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "OutputDataConfig"} + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } + if s.S3Uri == nil { + invalidParams.Add(request.NewErrParamRequired("S3Uri")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *OutputDataConfig) SetKmsKeyId(v string) *OutputDataConfig { + s.KmsKeyId = &v + return s +} + +// SetS3Uri sets the S3Uri field's value. +func (s *OutputDataConfig) SetS3Uri(v string) *OutputDataConfig { + s.S3Uri = &v + return s +} + +// The configuration definining the action to take when a duplicate fraudster +// is detected, and the similarity threshold to use for detecting a duplicate +// fraudster during a batch fraudster registration job. +type RegistrationConfig struct { + _ struct{} `type:"structure"` + + // The action to take when a fraudster is identified as a duplicate. The default + // action is SKIP, which skips registering the duplicate fraudster. Setting + // the value to REGISTER_AS_NEW always registers a new fraudster into the specified + // domain. + DuplicateRegistrationAction *string `type:"string" enum:"DuplicateRegistrationAction"` + + // The minimum similarity score between the new and old fraudsters in order + // to consider the new fraudster a duplicate. + FraudsterSimilarityThreshold *int64 `type:"integer"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegistrationConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s RegistrationConfig) GoString() string { + return s.String() +} + +// SetDuplicateRegistrationAction sets the DuplicateRegistrationAction field's value. +func (s *RegistrationConfig) SetDuplicateRegistrationAction(v string) *RegistrationConfig { + s.DuplicateRegistrationAction = &v + return s +} + +// SetFraudsterSimilarityThreshold sets the FraudsterSimilarityThreshold field's value. +func (s *RegistrationConfig) SetFraudsterSimilarityThreshold(v int64) *RegistrationConfig { + s.FraudsterSimilarityThreshold = &v + return s +} + +// The specified resource cannot be found. Check the ResourceType and error +// message for more details. +type ResourceNotFoundException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` + + // The type of resource which cannot not be found. Possible types are BATCH_JOB, + // COMPLIANCE_CONSENT, DOMAIN, FRAUDSTER, SESSION and SPEAKER. + ResourceType *string `type:"string" enum:"ResourceType"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ResourceNotFoundException) GoString() string { + return s.String() +} + +func newErrorResourceNotFoundException(v protocol.ResponseMetadata) error { + return &ResourceNotFoundException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ResourceNotFoundException) Code() string { + return "ResourceNotFoundException" +} + +// Message returns the exception's message. +func (s *ResourceNotFoundException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ResourceNotFoundException) OrigErr() error { + return nil +} + +func (s *ResourceNotFoundException) Error() string { + return fmt.Sprintf("%s: %s\n%s", s.Code(), s.Message(), s.String()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ResourceNotFoundException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ResourceNotFoundException) RequestID() string { + return s.RespMetadata.RequestID +} + +// The configuration containing information about the customer-managed KMS Key +// used for encrypting customer data. +type ServerSideEncryptionConfiguration struct { + _ struct{} `type:"structure"` + + // The identifier of the KMS Key you want Voice ID to use to encrypt your data. + // + // KmsKeyId is a required field + KmsKeyId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerSideEncryptionConfiguration) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServerSideEncryptionConfiguration) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ServerSideEncryptionConfiguration) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ServerSideEncryptionConfiguration"} + if s.KmsKeyId == nil { + invalidParams.Add(request.NewErrParamRequired("KmsKeyId")) + } + if s.KmsKeyId != nil && len(*s.KmsKeyId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("KmsKeyId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *ServerSideEncryptionConfiguration) SetKmsKeyId(v string) *ServerSideEncryptionConfiguration { + s.KmsKeyId = &v + return s +} + +// The request exceeded the service quota. Refer to Voice ID Service Quotas +// (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) +// and try your request again. +type ServiceQuotaExceededException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ServiceQuotaExceededException) GoString() string { + return s.String() +} + +func newErrorServiceQuotaExceededException(v protocol.ResponseMetadata) error { + return &ServiceQuotaExceededException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ServiceQuotaExceededException) Code() string { + return "ServiceQuotaExceededException" +} + +// Message returns the exception's message. +func (s *ServiceQuotaExceededException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ServiceQuotaExceededException) OrigErr() error { + return nil +} + +func (s *ServiceQuotaExceededException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ServiceQuotaExceededException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ServiceQuotaExceededException) RequestID() string { + return s.RespMetadata.RequestID +} + +// Contains all the information about a speaker. +type Speaker struct { + _ struct{} `type:"structure"` + + // A timestamp showing when the speaker is created. + CreatedAt *time.Time `type:"timestamp"` + + // The client-provided identifier for the speaker. + // + // CustomerSpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Speaker's + // String and GoString methods. + CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain that contains the speaker. + DomainId *string `min:"22" type:"string"` + + // The service-generated identifier for the speaker. + GeneratedSpeakerId *string `min:"25" type:"string"` + + // The current status of the speaker. + Status *string `type:"string" enum:"SpeakerStatus"` + + // A timestamp showing the speaker's last update. + UpdatedAt *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Speaker) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Speaker) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *Speaker) SetCreatedAt(v time.Time) *Speaker { + s.CreatedAt = &v + return s +} + +// SetCustomerSpeakerId sets the CustomerSpeakerId field's value. +func (s *Speaker) SetCustomerSpeakerId(v string) *Speaker { + s.CustomerSpeakerId = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *Speaker) SetDomainId(v string) *Speaker { + s.DomainId = &v + return s +} + +// SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value. +func (s *Speaker) SetGeneratedSpeakerId(v string) *Speaker { + s.GeneratedSpeakerId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *Speaker) SetStatus(v string) *Speaker { + s.Status = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *Speaker) SetUpdatedAt(v time.Time) *Speaker { + s.UpdatedAt = &v + return s +} + +// Contains all the information about a speaker enrollment job. +type SpeakerEnrollmentJob struct { + _ struct{} `type:"structure"` + + // A timestamp showing the creation of the speaker enrollment job. + CreatedAt *time.Time `type:"timestamp"` + + // 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. + DataAccessRoleArn *string `min:"20" type:"string"` + + // The identifier of the domain that contains the speaker enrollment job. + DomainId *string `min:"22" type:"string"` + + // A timestamp showing when the speaker enrollment job ended. + EndedAt *time.Time `type:"timestamp"` + + // The configuration that defines the action to take when the speaker is already + // enrolled in Voice ID, and the FraudDetectionConfig to use. + EnrollmentConfig *EnrollmentConfig `type:"structure"` + + // Contains details that are populated when an entire batch job fails. In cases + // of individual registration job failures, the batch job as a whole doesn't + // fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can + // use the job output file to identify the individual registration requests + // that failed. + FailureDetails *FailureDetails `type:"structure"` + + // The input data config containing an S3 URI for the input manifest file that + // contains the list of speaker enrollment job requests. + InputDataConfig *InputDataConfig `type:"structure"` + + // The service-generated identifier for the speaker enrollment job. + JobId *string `min:"22" type:"string"` + + // The client-provided name for the speaker enrollment job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SpeakerEnrollmentJob's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // Provides details on job progress. This field shows the completed percentage + // of registration requests listed in the input file. + JobProgress *JobProgress `type:"structure"` + + // The current status of the speaker enrollment job. + JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"` + + // The output data config containing the S3 location where Voice ID writes the + // job output file; you must also include a KMS Key ID to encrypt the file. + OutputDataConfig *OutputDataConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerEnrollmentJob) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerEnrollmentJob) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *SpeakerEnrollmentJob) SetCreatedAt(v time.Time) *SpeakerEnrollmentJob { + s.CreatedAt = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *SpeakerEnrollmentJob) SetDataAccessRoleArn(v string) *SpeakerEnrollmentJob { + s.DataAccessRoleArn = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *SpeakerEnrollmentJob) SetDomainId(v string) *SpeakerEnrollmentJob { + s.DomainId = &v + return s +} + +// SetEndedAt sets the EndedAt field's value. +func (s *SpeakerEnrollmentJob) SetEndedAt(v time.Time) *SpeakerEnrollmentJob { + s.EndedAt = &v + return s +} + +// SetEnrollmentConfig sets the EnrollmentConfig field's value. +func (s *SpeakerEnrollmentJob) SetEnrollmentConfig(v *EnrollmentConfig) *SpeakerEnrollmentJob { + s.EnrollmentConfig = v + return s +} + +// SetFailureDetails sets the FailureDetails field's value. +func (s *SpeakerEnrollmentJob) SetFailureDetails(v *FailureDetails) *SpeakerEnrollmentJob { + s.FailureDetails = v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *SpeakerEnrollmentJob) SetInputDataConfig(v *InputDataConfig) *SpeakerEnrollmentJob { + s.InputDataConfig = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *SpeakerEnrollmentJob) SetJobId(v string) *SpeakerEnrollmentJob { + s.JobId = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *SpeakerEnrollmentJob) SetJobName(v string) *SpeakerEnrollmentJob { + s.JobName = &v + return s +} + +// SetJobProgress sets the JobProgress field's value. +func (s *SpeakerEnrollmentJob) SetJobProgress(v *JobProgress) *SpeakerEnrollmentJob { + s.JobProgress = v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *SpeakerEnrollmentJob) SetJobStatus(v string) *SpeakerEnrollmentJob { + s.JobStatus = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *SpeakerEnrollmentJob) SetOutputDataConfig(v *OutputDataConfig) *SpeakerEnrollmentJob { + s.OutputDataConfig = v + return s +} + +// Contains a summary of information about a speaker enrollment job. +type SpeakerEnrollmentJobSummary struct { + _ struct{} `type:"structure"` + + // A timestamp showing the creation time of the speaker enrollment job. + CreatedAt *time.Time `type:"timestamp"` + + // The identifier of the domain that contains the speaker enrollment job. + DomainId *string `min:"22" type:"string"` + + // A timestamp showing when the speaker enrollment job ended. + EndedAt *time.Time `type:"timestamp"` + + // Contains details that are populated when an entire batch job fails. In cases + // of individual registration job failures, the batch job as a whole doesn't + // fail; it is completed with a JobStatus of COMPLETED_WITH_ERRORS. You can + // use the job output file to identify the individual registration requests + // that failed. + FailureDetails *FailureDetails `type:"structure"` + + // The service-generated identifier for the speaker enrollment job. + JobId *string `min:"22" type:"string"` + + // The client-provided name for the speaker enrollment job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SpeakerEnrollmentJobSummary's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // Provides details regarding job progress. This field shows the completed percentage + // of enrollment requests listed in the input file. + JobProgress *JobProgress `type:"structure"` + + // The current status of the speaker enrollment job. + JobStatus *string `type:"string" enum:"SpeakerEnrollmentJobStatus"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerEnrollmentJobSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerEnrollmentJobSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *SpeakerEnrollmentJobSummary) SetCreatedAt(v time.Time) *SpeakerEnrollmentJobSummary { + s.CreatedAt = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *SpeakerEnrollmentJobSummary) SetDomainId(v string) *SpeakerEnrollmentJobSummary { + s.DomainId = &v + return s +} + +// SetEndedAt sets the EndedAt field's value. +func (s *SpeakerEnrollmentJobSummary) SetEndedAt(v time.Time) *SpeakerEnrollmentJobSummary { + s.EndedAt = &v + return s +} + +// SetFailureDetails sets the FailureDetails field's value. +func (s *SpeakerEnrollmentJobSummary) SetFailureDetails(v *FailureDetails) *SpeakerEnrollmentJobSummary { + s.FailureDetails = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *SpeakerEnrollmentJobSummary) SetJobId(v string) *SpeakerEnrollmentJobSummary { + s.JobId = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *SpeakerEnrollmentJobSummary) SetJobName(v string) *SpeakerEnrollmentJobSummary { + s.JobName = &v + return s +} + +// SetJobProgress sets the JobProgress field's value. +func (s *SpeakerEnrollmentJobSummary) SetJobProgress(v *JobProgress) *SpeakerEnrollmentJobSummary { + s.JobProgress = v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *SpeakerEnrollmentJobSummary) SetJobStatus(v string) *SpeakerEnrollmentJobSummary { + s.JobStatus = &v + return s +} + +// Contains a summary of information about a speaker. +type SpeakerSummary struct { + _ struct{} `type:"structure"` + + // A timestamp showing the speaker's creation time. + CreatedAt *time.Time `type:"timestamp"` + + // The client-provided identifier for the speaker. + // + // CustomerSpeakerId is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by SpeakerSummary's + // String and GoString methods. + CustomerSpeakerId *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain that contains the speaker. + DomainId *string `min:"22" type:"string"` + + // The service-generated identifier for the speaker. + GeneratedSpeakerId *string `min:"25" type:"string"` + + // The current status of the speaker. + Status *string `type:"string" enum:"SpeakerStatus"` + + // A timestamp showing the speaker's last update. + UpdatedAt *time.Time `type:"timestamp"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerSummary) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s SpeakerSummary) GoString() string { + return s.String() +} + +// SetCreatedAt sets the CreatedAt field's value. +func (s *SpeakerSummary) SetCreatedAt(v time.Time) *SpeakerSummary { + s.CreatedAt = &v + return s +} + +// SetCustomerSpeakerId sets the CustomerSpeakerId field's value. +func (s *SpeakerSummary) SetCustomerSpeakerId(v string) *SpeakerSummary { + s.CustomerSpeakerId = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *SpeakerSummary) SetDomainId(v string) *SpeakerSummary { + s.DomainId = &v + return s +} + +// SetGeneratedSpeakerId sets the GeneratedSpeakerId field's value. +func (s *SpeakerSummary) SetGeneratedSpeakerId(v string) *SpeakerSummary { + s.GeneratedSpeakerId = &v + return s +} + +// SetStatus sets the Status field's value. +func (s *SpeakerSummary) SetStatus(v string) *SpeakerSummary { + s.Status = &v + return s +} + +// SetUpdatedAt sets the UpdatedAt field's value. +func (s *SpeakerSummary) SetUpdatedAt(v time.Time) *SpeakerSummary { + s.UpdatedAt = &v + return s +} + +type StartFraudsterRegistrationJobInput struct { + _ struct{} `type:"structure"` + + // The idempotency token for starting a new fraudster registration job. If not + // provided, Amazon Web Services SDK populates this field. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // 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 the Create and edit a fraudster watchlist (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-fraudster-watchlist.html) + // documentation for the permissions needed in this role. + // + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // The identifier of the domain containing the fraudster registration job and + // in which the fraudsters are registered. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The input data config containing an S3 URI for the input manifest file that + // contains the list of fraudster registration requests. + // + // InputDataConfig is a required field + InputDataConfig *InputDataConfig `type:"structure" required:"true"` + + // The name of the new fraudster registration job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartFraudsterRegistrationJobInput's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // The output data config containing the S3 location where Voice ID writes the + // job output file; you must also include a KMS Key ID to encrypt the file. + // + // OutputDataConfig is a required field + OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` + + // 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. + RegistrationConfig *RegistrationConfig `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartFraudsterRegistrationJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartFraudsterRegistrationJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartFraudsterRegistrationJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartFraudsterRegistrationJobInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DataAccessRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("DataAccessRoleArn")) + } + if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) + } + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.OutputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("OutputDataConfig")) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.OutputDataConfig != nil { + if err := s.OutputDataConfig.Validate(); err != nil { + invalidParams.AddNested("OutputDataConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartFraudsterRegistrationJobInput) SetClientToken(v string) *StartFraudsterRegistrationJobInput { + s.ClientToken = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *StartFraudsterRegistrationJobInput) SetDataAccessRoleArn(v string) *StartFraudsterRegistrationJobInput { + s.DataAccessRoleArn = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *StartFraudsterRegistrationJobInput) SetDomainId(v string) *StartFraudsterRegistrationJobInput { + s.DomainId = &v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *StartFraudsterRegistrationJobInput) SetInputDataConfig(v *InputDataConfig) *StartFraudsterRegistrationJobInput { + s.InputDataConfig = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *StartFraudsterRegistrationJobInput) SetJobName(v string) *StartFraudsterRegistrationJobInput { + s.JobName = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *StartFraudsterRegistrationJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartFraudsterRegistrationJobInput { + s.OutputDataConfig = v + return s +} + +// SetRegistrationConfig sets the RegistrationConfig field's value. +func (s *StartFraudsterRegistrationJobInput) SetRegistrationConfig(v *RegistrationConfig) *StartFraudsterRegistrationJobInput { + s.RegistrationConfig = v + return s +} + +type StartFraudsterRegistrationJobOutput struct { + _ struct{} `type:"structure"` + + // Details about the started fraudster registration job. + Job *FraudsterRegistrationJob `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartFraudsterRegistrationJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartFraudsterRegistrationJobOutput) GoString() string { + return s.String() +} + +// SetJob sets the Job field's value. +func (s *StartFraudsterRegistrationJobOutput) SetJob(v *FraudsterRegistrationJob) *StartFraudsterRegistrationJobOutput { + s.Job = v + return s +} + +type StartSpeakerEnrollmentJobInput struct { + _ struct{} `type:"structure"` + + // The idempotency token for starting a new speaker enrollment Job. If not provided, + // Amazon Web Services SDK populates this field. + ClientToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // 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 Batch enrollment using audio data from prior calls + // (https://docs.aws.amazon.com/connect/latest/adminguide/voiceid-batch-enrollment.html) + // documentation for the permissions needed in this role. + // + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // The identifier of the domain that contains the speaker enrollment job and + // in which the speakers are enrolled. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The enrollment config that contains details such as the action to take when + // a speaker is already enrolled in the Voice ID system or when a speaker is + // identified as a fraudster. + EnrollmentConfig *EnrollmentConfig `type:"structure"` + + // The input data config containing the S3 location for the input manifest file + // that contains the list of speaker enrollment requests. + // + // InputDataConfig is a required field + InputDataConfig *InputDataConfig `type:"structure" required:"true"` + + // A name for your speaker enrollment job. + // + // JobName is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by StartSpeakerEnrollmentJobInput's + // String and GoString methods. + JobName *string `min:"1" type:"string" sensitive:"true"` + + // The output data config containing the S3 location where Voice ID writes the + // job output file; you must also include a KMS Key ID to encrypt the file. + // + // OutputDataConfig is a required field + OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSpeakerEnrollmentJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSpeakerEnrollmentJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartSpeakerEnrollmentJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartSpeakerEnrollmentJobInput"} + if s.ClientToken != nil && len(*s.ClientToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientToken", 1)) + } + if s.DataAccessRoleArn == nil { + invalidParams.Add(request.NewErrParamRequired("DataAccessRoleArn")) + } + if s.DataAccessRoleArn != nil && len(*s.DataAccessRoleArn) < 20 { + invalidParams.Add(request.NewErrParamMinLen("DataAccessRoleArn", 20)) + } + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.OutputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("OutputDataConfig")) + } + if s.InputDataConfig != nil { + if err := s.InputDataConfig.Validate(); err != nil { + invalidParams.AddNested("InputDataConfig", err.(request.ErrInvalidParams)) + } + } + if s.OutputDataConfig != nil { + if err := s.OutputDataConfig.Validate(); err != nil { + invalidParams.AddNested("OutputDataConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientToken sets the ClientToken field's value. +func (s *StartSpeakerEnrollmentJobInput) SetClientToken(v string) *StartSpeakerEnrollmentJobInput { + s.ClientToken = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *StartSpeakerEnrollmentJobInput) SetDataAccessRoleArn(v string) *StartSpeakerEnrollmentJobInput { + s.DataAccessRoleArn = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *StartSpeakerEnrollmentJobInput) SetDomainId(v string) *StartSpeakerEnrollmentJobInput { + s.DomainId = &v + return s +} + +// SetEnrollmentConfig sets the EnrollmentConfig field's value. +func (s *StartSpeakerEnrollmentJobInput) SetEnrollmentConfig(v *EnrollmentConfig) *StartSpeakerEnrollmentJobInput { + s.EnrollmentConfig = v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *StartSpeakerEnrollmentJobInput) SetInputDataConfig(v *InputDataConfig) *StartSpeakerEnrollmentJobInput { + s.InputDataConfig = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *StartSpeakerEnrollmentJobInput) SetJobName(v string) *StartSpeakerEnrollmentJobInput { + s.JobName = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *StartSpeakerEnrollmentJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartSpeakerEnrollmentJobInput { + s.OutputDataConfig = v + return s +} + +type StartSpeakerEnrollmentJobOutput struct { + _ struct{} `type:"structure"` + + // Details about the started speaker enrollment job. + Job *SpeakerEnrollmentJob `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSpeakerEnrollmentJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s StartSpeakerEnrollmentJobOutput) GoString() string { + return s.String() +} + +// SetJob sets the Job field's value. +func (s *StartSpeakerEnrollmentJobOutput) SetJob(v *SpeakerEnrollmentJob) *StartSpeakerEnrollmentJobOutput { + s.Job = v + return s +} + +// A tag that can be assigned to a Voice ID resource. +type Tag struct { + _ struct{} `type:"structure"` + + // 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'. + // + // Key is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Tag's + // String and GoString methods. + // + // Key is a required field + Key *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // 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'. + // + // Value is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by Tag's + // String and GoString methods. + // + // Value is a required field + Value *string `type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s Tag) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *Tag) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "Tag"} + if s.Key == nil { + invalidParams.Add(request.NewErrParamRequired("Key")) + } + if s.Key != nil && len(*s.Key) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Key", 1)) + } + if s.Value == nil { + invalidParams.Add(request.NewErrParamRequired("Value")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetKey sets the Key field's value. +func (s *Tag) SetKey(v string) *Tag { + s.Key = &v + return s +} + +// SetValue sets the Value field's value. +func (s *Tag) SetValue(v string) *Tag { + s.Value = &v + return s +} + +type TagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Voice ID resource you want to tag. + // + // ResourceArn is a required field + ResourceArn *string `min:"1" type:"string" required:"true"` + + // The list of tags to assign to the specified resource. + // + // Tags is a required field + Tags []*Tag `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *TagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "TagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.Tags == nil { + invalidParams.Add(request.NewErrParamRequired("Tags")) + } + if s.Tags != nil { + for i, v := range s.Tags { + if v == nil { + continue + } + if err := v.Validate(); err != nil { + invalidParams.AddNested(fmt.Sprintf("%s[%v]", "Tags", i), err.(request.ErrInvalidParams)) + } + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTags sets the Tags field's value. +func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput { + s.Tags = v + return s +} + +type TagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s TagResourceOutput) GoString() string { + return s.String() +} + +// The request was denied due to request throttling. Please slow down your request +// rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) +// and try your request again. +type ThrottlingException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ThrottlingException) GoString() string { + return s.String() +} + +func newErrorThrottlingException(v protocol.ResponseMetadata) error { + return &ThrottlingException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ThrottlingException) Code() string { + return "ThrottlingException" +} + +// Message returns the exception's message. +func (s *ThrottlingException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ThrottlingException) OrigErr() error { + return nil +} + +func (s *ThrottlingException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ThrottlingException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ThrottlingException) RequestID() string { + return s.RespMetadata.RequestID +} + +type UntagResourceInput struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) of the Voice ID resource you want to remove + // tags from. + // + // ResourceArn is a required field + ResourceArn *string `min:"1" type:"string" required:"true"` + + // The list of tag keys you want to remove from the specified resource. + // + // TagKeys is a required field + TagKeys []*string `type:"list" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UntagResourceInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UntagResourceInput"} + if s.ResourceArn == nil { + invalidParams.Add(request.NewErrParamRequired("ResourceArn")) + } + if s.ResourceArn != nil && len(*s.ResourceArn) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ResourceArn", 1)) + } + if s.TagKeys == nil { + invalidParams.Add(request.NewErrParamRequired("TagKeys")) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetResourceArn sets the ResourceArn field's value. +func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput { + s.ResourceArn = &v + return s +} + +// SetTagKeys sets the TagKeys field's value. +func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput { + s.TagKeys = v + return s +} + +type UntagResourceOutput struct { + _ struct{} `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UntagResourceOutput) GoString() string { + return s.String() +} + +type UpdateDomainInput struct { + _ struct{} `type:"structure"` + + // A brief description about this domain. + // + // Description is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateDomainInput's + // String and GoString methods. + Description *string `min:"1" type:"string" sensitive:"true"` + + // The identifier of the domain to be updated. + // + // DomainId is a required field + DomainId *string `min:"22" type:"string" required:"true"` + + // The name of the domain. + // + // Name is a sensitive parameter and its value will be + // replaced with "sensitive" in string returned by UpdateDomainInput's + // String and GoString methods. + // + // Name is a required field + Name *string `min:"1" type:"string" required:"true" sensitive:"true"` + + // 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. + // + // ServerSideEncryptionConfiguration is a required field + ServerSideEncryptionConfiguration *ServerSideEncryptionConfiguration `type:"structure" required:"true"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *UpdateDomainInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "UpdateDomainInput"} + if s.Description != nil && len(*s.Description) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Description", 1)) + } + if s.DomainId == nil { + invalidParams.Add(request.NewErrParamRequired("DomainId")) + } + if s.DomainId != nil && len(*s.DomainId) < 22 { + invalidParams.Add(request.NewErrParamMinLen("DomainId", 22)) + } + if s.Name == nil { + invalidParams.Add(request.NewErrParamRequired("Name")) + } + if s.Name != nil && len(*s.Name) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Name", 1)) + } + if s.ServerSideEncryptionConfiguration == nil { + invalidParams.Add(request.NewErrParamRequired("ServerSideEncryptionConfiguration")) + } + if s.ServerSideEncryptionConfiguration != nil { + if err := s.ServerSideEncryptionConfiguration.Validate(); err != nil { + invalidParams.AddNested("ServerSideEncryptionConfiguration", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetDescription sets the Description field's value. +func (s *UpdateDomainInput) SetDescription(v string) *UpdateDomainInput { + s.Description = &v + return s +} + +// SetDomainId sets the DomainId field's value. +func (s *UpdateDomainInput) SetDomainId(v string) *UpdateDomainInput { + s.DomainId = &v + return s +} + +// SetName sets the Name field's value. +func (s *UpdateDomainInput) SetName(v string) *UpdateDomainInput { + s.Name = &v + return s +} + +// SetServerSideEncryptionConfiguration sets the ServerSideEncryptionConfiguration field's value. +func (s *UpdateDomainInput) SetServerSideEncryptionConfiguration(v *ServerSideEncryptionConfiguration) *UpdateDomainInput { + s.ServerSideEncryptionConfiguration = v + return s +} + +type UpdateDomainOutput struct { + _ struct{} `type:"structure"` + + // Details about the updated domain + Domain *Domain `type:"structure"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s UpdateDomainOutput) GoString() string { + return s.String() +} + +// SetDomain sets the Domain field's value. +func (s *UpdateDomainOutput) SetDomain(v *Domain) *UpdateDomainOutput { + s.Domain = v + return s +} + +// The request failed one or more validations; check the error message for more +// details. +type ValidationException struct { + _ struct{} `type:"structure"` + RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"` + + Message_ *string `locationName:"Message" min:"1" type:"string"` +} + +// String returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation. +// +// API parameter values that are decorated as "sensitive" in the API will not +// be included in the string output. The member name will be present, but the +// value will be replaced with "sensitive". +func (s ValidationException) GoString() string { + return s.String() +} + +func newErrorValidationException(v protocol.ResponseMetadata) error { + return &ValidationException{ + RespMetadata: v, + } +} + +// Code returns the exception type name. +func (s *ValidationException) Code() string { + return "ValidationException" +} + +// Message returns the exception's message. +func (s *ValidationException) Message() string { + if s.Message_ != nil { + return *s.Message_ + } + return "" +} + +// OrigErr always returns nil, satisfies awserr.Error interface. +func (s *ValidationException) OrigErr() error { + return nil +} + +func (s *ValidationException) Error() string { + return fmt.Sprintf("%s: %s", s.Code(), s.Message()) +} + +// Status code returns the HTTP status code for the request's response error. +func (s *ValidationException) StatusCode() int { + return s.RespMetadata.StatusCode +} + +// RequestID returns the service's response RequestID for request. +func (s *ValidationException) RequestID() string { + return s.RespMetadata.RequestID +} + +const ( + // AuthenticationDecisionAccept is a AuthenticationDecision enum value + AuthenticationDecisionAccept = "ACCEPT" + + // AuthenticationDecisionReject is a AuthenticationDecision enum value + AuthenticationDecisionReject = "REJECT" + + // AuthenticationDecisionNotEnoughSpeech is a AuthenticationDecision enum value + AuthenticationDecisionNotEnoughSpeech = "NOT_ENOUGH_SPEECH" + + // AuthenticationDecisionSpeakerNotEnrolled is a AuthenticationDecision enum value + AuthenticationDecisionSpeakerNotEnrolled = "SPEAKER_NOT_ENROLLED" + + // AuthenticationDecisionSpeakerOptedOut is a AuthenticationDecision enum value + AuthenticationDecisionSpeakerOptedOut = "SPEAKER_OPTED_OUT" + + // AuthenticationDecisionSpeakerIdNotProvided is a AuthenticationDecision enum value + AuthenticationDecisionSpeakerIdNotProvided = "SPEAKER_ID_NOT_PROVIDED" +) + +// AuthenticationDecision_Values returns all elements of the AuthenticationDecision enum +func AuthenticationDecision_Values() []string { + return []string{ + AuthenticationDecisionAccept, + AuthenticationDecisionReject, + AuthenticationDecisionNotEnoughSpeech, + AuthenticationDecisionSpeakerNotEnrolled, + AuthenticationDecisionSpeakerOptedOut, + AuthenticationDecisionSpeakerIdNotProvided, + } +} + +const ( + // ConflictTypeAnotherActiveStream is a ConflictType enum value + ConflictTypeAnotherActiveStream = "ANOTHER_ACTIVE_STREAM" + + // ConflictTypeDomainNotActive is a ConflictType enum value + ConflictTypeDomainNotActive = "DOMAIN_NOT_ACTIVE" + + // ConflictTypeCannotChangeSpeakerAfterEnrollment is a ConflictType enum value + ConflictTypeCannotChangeSpeakerAfterEnrollment = "CANNOT_CHANGE_SPEAKER_AFTER_ENROLLMENT" + + // ConflictTypeEnrollmentAlreadyExists is a ConflictType enum value + ConflictTypeEnrollmentAlreadyExists = "ENROLLMENT_ALREADY_EXISTS" + + // ConflictTypeSpeakerNotSet is a ConflictType enum value + ConflictTypeSpeakerNotSet = "SPEAKER_NOT_SET" + + // ConflictTypeSpeakerOptedOut is a ConflictType enum value + ConflictTypeSpeakerOptedOut = "SPEAKER_OPTED_OUT" + + // ConflictTypeConcurrentChanges is a ConflictType enum value + ConflictTypeConcurrentChanges = "CONCURRENT_CHANGES" +) + +// ConflictType_Values returns all elements of the ConflictType enum +func ConflictType_Values() []string { + return []string{ + ConflictTypeAnotherActiveStream, + ConflictTypeDomainNotActive, + ConflictTypeCannotChangeSpeakerAfterEnrollment, + ConflictTypeEnrollmentAlreadyExists, + ConflictTypeSpeakerNotSet, + ConflictTypeSpeakerOptedOut, + ConflictTypeConcurrentChanges, + } +} + +const ( + // DomainStatusActive is a DomainStatus enum value + DomainStatusActive = "ACTIVE" + + // DomainStatusPending is a DomainStatus enum value + DomainStatusPending = "PENDING" + + // DomainStatusSuspended is a DomainStatus enum value + DomainStatusSuspended = "SUSPENDED" +) + +// DomainStatus_Values returns all elements of the DomainStatus enum +func DomainStatus_Values() []string { + return []string{ + DomainStatusActive, + DomainStatusPending, + DomainStatusSuspended, + } +} + +const ( + // DuplicateRegistrationActionSkip is a DuplicateRegistrationAction enum value + DuplicateRegistrationActionSkip = "SKIP" + + // DuplicateRegistrationActionRegisterAsNew is a DuplicateRegistrationAction enum value + DuplicateRegistrationActionRegisterAsNew = "REGISTER_AS_NEW" +) + +// DuplicateRegistrationAction_Values returns all elements of the DuplicateRegistrationAction enum +func DuplicateRegistrationAction_Values() []string { + return []string{ + DuplicateRegistrationActionSkip, + DuplicateRegistrationActionRegisterAsNew, + } +} + +const ( + // ExistingEnrollmentActionSkip is a ExistingEnrollmentAction enum value + ExistingEnrollmentActionSkip = "SKIP" + + // ExistingEnrollmentActionOverwrite is a ExistingEnrollmentAction enum value + ExistingEnrollmentActionOverwrite = "OVERWRITE" +) + +// ExistingEnrollmentAction_Values returns all elements of the ExistingEnrollmentAction enum +func ExistingEnrollmentAction_Values() []string { + return []string{ + ExistingEnrollmentActionSkip, + ExistingEnrollmentActionOverwrite, + } +} + +const ( + // FraudDetectionActionIgnore is a FraudDetectionAction enum value + FraudDetectionActionIgnore = "IGNORE" + + // FraudDetectionActionFail is a FraudDetectionAction enum value + FraudDetectionActionFail = "FAIL" +) + +// FraudDetectionAction_Values returns all elements of the FraudDetectionAction enum +func FraudDetectionAction_Values() []string { + return []string{ + FraudDetectionActionIgnore, + FraudDetectionActionFail, + } +} + +const ( + // FraudDetectionDecisionHighRisk is a FraudDetectionDecision enum value + FraudDetectionDecisionHighRisk = "HIGH_RISK" + + // FraudDetectionDecisionLowRisk is a FraudDetectionDecision enum value + FraudDetectionDecisionLowRisk = "LOW_RISK" + + // FraudDetectionDecisionNotEnoughSpeech is a FraudDetectionDecision enum value + FraudDetectionDecisionNotEnoughSpeech = "NOT_ENOUGH_SPEECH" +) + +// FraudDetectionDecision_Values returns all elements of the FraudDetectionDecision enum +func FraudDetectionDecision_Values() []string { + return []string{ + FraudDetectionDecisionHighRisk, + FraudDetectionDecisionLowRisk, + FraudDetectionDecisionNotEnoughSpeech, + } +} + +const ( + // FraudDetectionReasonKnownFraudster is a FraudDetectionReason enum value + FraudDetectionReasonKnownFraudster = "KNOWN_FRAUDSTER" +) + +// FraudDetectionReason_Values returns all elements of the FraudDetectionReason enum +func FraudDetectionReason_Values() []string { + return []string{ + FraudDetectionReasonKnownFraudster, + } +} + +const ( + // FraudsterRegistrationJobStatusSubmitted is a FraudsterRegistrationJobStatus enum value + FraudsterRegistrationJobStatusSubmitted = "SUBMITTED" + + // FraudsterRegistrationJobStatusInProgress is a FraudsterRegistrationJobStatus enum value + FraudsterRegistrationJobStatusInProgress = "IN_PROGRESS" + + // FraudsterRegistrationJobStatusCompleted is a FraudsterRegistrationJobStatus enum value + FraudsterRegistrationJobStatusCompleted = "COMPLETED" + + // FraudsterRegistrationJobStatusCompletedWithErrors is a FraudsterRegistrationJobStatus enum value + FraudsterRegistrationJobStatusCompletedWithErrors = "COMPLETED_WITH_ERRORS" + + // FraudsterRegistrationJobStatusFailed is a FraudsterRegistrationJobStatus enum value + FraudsterRegistrationJobStatusFailed = "FAILED" +) + +// FraudsterRegistrationJobStatus_Values returns all elements of the FraudsterRegistrationJobStatus enum +func FraudsterRegistrationJobStatus_Values() []string { + return []string{ + FraudsterRegistrationJobStatusSubmitted, + FraudsterRegistrationJobStatusInProgress, + FraudsterRegistrationJobStatusCompleted, + FraudsterRegistrationJobStatusCompletedWithErrors, + FraudsterRegistrationJobStatusFailed, + } +} + +const ( + // ResourceTypeBatchJob is a ResourceType enum value + ResourceTypeBatchJob = "BATCH_JOB" + + // ResourceTypeComplianceConsent is a ResourceType enum value + ResourceTypeComplianceConsent = "COMPLIANCE_CONSENT" + + // ResourceTypeDomain is a ResourceType enum value + ResourceTypeDomain = "DOMAIN" + + // ResourceTypeFraudster is a ResourceType enum value + ResourceTypeFraudster = "FRAUDSTER" + + // ResourceTypeSession is a ResourceType enum value + ResourceTypeSession = "SESSION" + + // ResourceTypeSpeaker is a ResourceType enum value + ResourceTypeSpeaker = "SPEAKER" +) + +// ResourceType_Values returns all elements of the ResourceType enum +func ResourceType_Values() []string { + return []string{ + ResourceTypeBatchJob, + ResourceTypeComplianceConsent, + ResourceTypeDomain, + ResourceTypeFraudster, + ResourceTypeSession, + ResourceTypeSpeaker, + } +} + +const ( + // SpeakerEnrollmentJobStatusSubmitted is a SpeakerEnrollmentJobStatus enum value + SpeakerEnrollmentJobStatusSubmitted = "SUBMITTED" + + // SpeakerEnrollmentJobStatusInProgress is a SpeakerEnrollmentJobStatus enum value + SpeakerEnrollmentJobStatusInProgress = "IN_PROGRESS" + + // SpeakerEnrollmentJobStatusCompleted is a SpeakerEnrollmentJobStatus enum value + SpeakerEnrollmentJobStatusCompleted = "COMPLETED" + + // SpeakerEnrollmentJobStatusCompletedWithErrors is a SpeakerEnrollmentJobStatus enum value + SpeakerEnrollmentJobStatusCompletedWithErrors = "COMPLETED_WITH_ERRORS" + + // SpeakerEnrollmentJobStatusFailed is a SpeakerEnrollmentJobStatus enum value + SpeakerEnrollmentJobStatusFailed = "FAILED" +) + +// SpeakerEnrollmentJobStatus_Values returns all elements of the SpeakerEnrollmentJobStatus enum +func SpeakerEnrollmentJobStatus_Values() []string { + return []string{ + SpeakerEnrollmentJobStatusSubmitted, + SpeakerEnrollmentJobStatusInProgress, + SpeakerEnrollmentJobStatusCompleted, + SpeakerEnrollmentJobStatusCompletedWithErrors, + SpeakerEnrollmentJobStatusFailed, + } +} + +const ( + // SpeakerStatusEnrolled is a SpeakerStatus enum value + SpeakerStatusEnrolled = "ENROLLED" + + // SpeakerStatusExpired is a SpeakerStatus enum value + SpeakerStatusExpired = "EXPIRED" + + // SpeakerStatusOptedOut is a SpeakerStatus enum value + SpeakerStatusOptedOut = "OPTED_OUT" + + // SpeakerStatusPending is a SpeakerStatus enum value + SpeakerStatusPending = "PENDING" +) + +// SpeakerStatus_Values returns all elements of the SpeakerStatus enum +func SpeakerStatus_Values() []string { + return []string{ + SpeakerStatusEnrolled, + SpeakerStatusExpired, + SpeakerStatusOptedOut, + SpeakerStatusPending, + } +} + +const ( + // StreamingStatusPendingConfiguration is a StreamingStatus enum value + StreamingStatusPendingConfiguration = "PENDING_CONFIGURATION" + + // StreamingStatusOngoing is a StreamingStatus enum value + StreamingStatusOngoing = "ONGOING" + + // StreamingStatusEnded is a StreamingStatus enum value + StreamingStatusEnded = "ENDED" +) + +// StreamingStatus_Values returns all elements of the StreamingStatus enum +func StreamingStatus_Values() []string { + return []string{ + StreamingStatusPendingConfiguration, + StreamingStatusOngoing, + StreamingStatusEnded, + } +} diff --git a/service/voiceid/doc.go b/service/voiceid/doc.go new file mode 100644 index 00000000000..d7b8667d28c --- /dev/null +++ b/service/voiceid/doc.go @@ -0,0 +1,29 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package voiceid provides the client and types for making API +// requests to Amazon Voice ID. +// +// Amazon Connect Voice ID provides real-time caller authentication and fraud +// screening. This guide describes the APIs used for this service. +// +// See https://docs.aws.amazon.com/goto/WebAPI/voice-id-2021-09-27 for more information on this service. +// +// See voiceid package documentation for more information. +// https://docs.aws.amazon.com/sdk-for-go/api/service/voiceid/ +// +// Using the Client +// +// To contact Amazon Voice ID with the SDK use the New function to create +// a new service client. With that client you can make API requests to the service. +// These clients are safe to use concurrently. +// +// See the SDK's documentation for more information on how to use the SDK. +// https://docs.aws.amazon.com/sdk-for-go/api/ +// +// See aws.Config documentation for more information on configuring SDK clients. +// https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config +// +// See the Amazon Voice ID client VoiceID for more +// information on creating client for this service. +// https://docs.aws.amazon.com/sdk-for-go/api/service/voiceid/#New +package voiceid diff --git a/service/voiceid/errors.go b/service/voiceid/errors.go new file mode 100644 index 00000000000..31ef98b04fe --- /dev/null +++ b/service/voiceid/errors.go @@ -0,0 +1,70 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package voiceid + +import ( + "github.com/aws/aws-sdk-go/private/protocol" +) + +const ( + + // ErrCodeAccessDeniedException for service response error code + // "AccessDeniedException". + // + // You do not have sufficient permissions to perform this action. Check the + // error message and try again. + ErrCodeAccessDeniedException = "AccessDeniedException" + + // ErrCodeConflictException for service response error code + // "ConflictException". + // + // The request failed due to a conflict. Check the ConflictType and error message + // for more details. + ErrCodeConflictException = "ConflictException" + + // ErrCodeInternalServerException for service response error code + // "InternalServerException". + // + // The request failed due to an unknown error on the server side. + ErrCodeInternalServerException = "InternalServerException" + + // ErrCodeResourceNotFoundException for service response error code + // "ResourceNotFoundException". + // + // The specified resource cannot be found. Check the ResourceType and error + // message for more details. + ErrCodeResourceNotFoundException = "ResourceNotFoundException" + + // ErrCodeServiceQuotaExceededException for service response error code + // "ServiceQuotaExceededException". + // + // The request exceeded the service quota. Refer to Voice ID Service Quotas + // (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#voiceid-quotas) + // and try your request again. + ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException" + + // ErrCodeThrottlingException for service response error code + // "ThrottlingException". + // + // The request was denied due to request throttling. Please slow down your request + // rate. Refer to Amazon Connect Voice ID Service API throttling quotas (https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html##voiceid-api-quotas) + // and try your request again. + ErrCodeThrottlingException = "ThrottlingException" + + // ErrCodeValidationException for service response error code + // "ValidationException". + // + // The request failed one or more validations; check the error message for more + // details. + ErrCodeValidationException = "ValidationException" +) + +var exceptionFromCode = map[string]func(protocol.ResponseMetadata) error{ + "AccessDeniedException": newErrorAccessDeniedException, + "ConflictException": newErrorConflictException, + "InternalServerException": newErrorInternalServerException, + "ResourceNotFoundException": newErrorResourceNotFoundException, + "ServiceQuotaExceededException": newErrorServiceQuotaExceededException, + "ThrottlingException": newErrorThrottlingException, + "ValidationException": newErrorValidationException, +} diff --git a/service/voiceid/service.go b/service/voiceid/service.go new file mode 100644 index 00000000000..f946355106b --- /dev/null +++ b/service/voiceid/service.go @@ -0,0 +1,106 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +package voiceid + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/client" + "github.com/aws/aws-sdk-go/aws/client/metadata" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/aws/signer/v4" + "github.com/aws/aws-sdk-go/private/protocol" + "github.com/aws/aws-sdk-go/private/protocol/jsonrpc" +) + +// VoiceID provides the API operation methods for making requests to +// Amazon Voice ID. See this package's package overview docs +// for details on the service. +// +// VoiceID methods are safe to use concurrently. It is not safe to +// modify mutate any of the struct's properties though. +type VoiceID struct { + *client.Client +} + +// Used for custom client initialization logic +var initClient func(*client.Client) + +// Used for custom request initialization logic +var initRequest func(*request.Request) + +// Service information constants +const ( + ServiceName = "Voice ID" // Name of service. + EndpointsID = "voiceid" // ID to lookup a service endpoint with. + ServiceID = "Voice ID" // ServiceID is a unique identifier of a specific service. +) + +// New creates a new instance of the VoiceID client with a session. +// If additional configuration is needed for the client instance use the optional +// aws.Config parameter to add your extra config. +// +// Example: +// mySession := session.Must(session.NewSession()) +// +// // Create a VoiceID client from just a session. +// svc := voiceid.New(mySession) +// +// // Create a VoiceID client with additional configuration +// svc := voiceid.New(mySession, aws.NewConfig().WithRegion("us-west-2")) +func New(p client.ConfigProvider, cfgs ...*aws.Config) *VoiceID { + c := p.ClientConfig(EndpointsID, cfgs...) + if c.SigningNameDerived || len(c.SigningName) == 0 { + c.SigningName = "voiceid" + } + return newClient(*c.Config, c.Handlers, c.PartitionID, c.Endpoint, c.SigningRegion, c.SigningName) +} + +// newClient creates, initializes and returns a new service client instance. +func newClient(cfg aws.Config, handlers request.Handlers, partitionID, endpoint, signingRegion, signingName string) *VoiceID { + svc := &VoiceID{ + Client: client.New( + cfg, + metadata.ClientInfo{ + ServiceName: ServiceName, + ServiceID: ServiceID, + SigningName: signingName, + SigningRegion: signingRegion, + PartitionID: partitionID, + Endpoint: endpoint, + APIVersion: "2021-09-27", + JSONVersion: "1.0", + TargetPrefix: "VoiceID", + }, + handlers, + ), + } + + // Handlers + svc.Handlers.Sign.PushBackNamed(v4.SignRequestHandler) + svc.Handlers.Build.PushBackNamed(jsonrpc.BuildHandler) + svc.Handlers.Unmarshal.PushBackNamed(jsonrpc.UnmarshalHandler) + svc.Handlers.UnmarshalMeta.PushBackNamed(jsonrpc.UnmarshalMetaHandler) + svc.Handlers.UnmarshalError.PushBackNamed( + protocol.NewUnmarshalErrorHandler(jsonrpc.NewUnmarshalTypedError(exceptionFromCode)).NamedHandler(), + ) + + // Run custom client initialization if present + if initClient != nil { + initClient(svc.Client) + } + + return svc +} + +// newRequest creates a new request for a VoiceID operation and runs any +// custom request initialization. +func (c *VoiceID) newRequest(op *request.Operation, params, data interface{}) *request.Request { + req := c.NewRequest(op, params, data) + + // Run custom request initialization if present + if initRequest != nil { + initRequest(req) + } + + return req +} diff --git a/service/voiceid/voiceidiface/interface.go b/service/voiceid/voiceidiface/interface.go new file mode 100644 index 00000000000..fa0f8164c35 --- /dev/null +++ b/service/voiceid/voiceidiface/interface.go @@ -0,0 +1,160 @@ +// Code generated by private/model/cli/gen-api/main.go. DO NOT EDIT. + +// Package voiceidiface provides an interface to enable mocking the Amazon Voice ID service client +// for testing your code. +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. +package voiceidiface + +import ( + "github.com/aws/aws-sdk-go/aws" + "github.com/aws/aws-sdk-go/aws/request" + "github.com/aws/aws-sdk-go/service/voiceid" +) + +// VoiceIDAPI provides an interface to enable mocking the +// voiceid.VoiceID service client's API operation, +// paginators, and waiters. This make unit testing your code that calls out +// to the SDK's service client's calls easier. +// +// The best way to use this interface is so the SDK's service client's calls +// can be stubbed out for unit testing your code with the SDK without needing +// to inject custom request handlers into the SDK's request pipeline. +// +// // myFunc uses an SDK service client to make a request to +// // Amazon Voice ID. +// func myFunc(svc voiceidiface.VoiceIDAPI) bool { +// // Make svc.CreateDomain request +// } +// +// func main() { +// sess := session.New() +// svc := voiceid.New(sess) +// +// myFunc(svc) +// } +// +// In your _test.go file: +// +// // Define a mock struct to be used in your unit tests of myFunc. +// type mockVoiceIDClient struct { +// voiceidiface.VoiceIDAPI +// } +// func (m *mockVoiceIDClient) CreateDomain(input *voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error) { +// // mock response/functionality +// } +// +// func TestMyFunc(t *testing.T) { +// // Setup Test +// mockSvc := &mockVoiceIDClient{} +// +// myfunc(mockSvc) +// +// // Verify myFunc's functionality +// } +// +// It is important to note that this interface will have breaking changes +// when the service model is updated and adds new API operations, paginators, +// and waiters. Its suggested to use the pattern above for testing, or using +// tooling to generate mocks to satisfy the interfaces. +type VoiceIDAPI interface { + CreateDomain(*voiceid.CreateDomainInput) (*voiceid.CreateDomainOutput, error) + CreateDomainWithContext(aws.Context, *voiceid.CreateDomainInput, ...request.Option) (*voiceid.CreateDomainOutput, error) + CreateDomainRequest(*voiceid.CreateDomainInput) (*request.Request, *voiceid.CreateDomainOutput) + + DeleteDomain(*voiceid.DeleteDomainInput) (*voiceid.DeleteDomainOutput, error) + DeleteDomainWithContext(aws.Context, *voiceid.DeleteDomainInput, ...request.Option) (*voiceid.DeleteDomainOutput, error) + DeleteDomainRequest(*voiceid.DeleteDomainInput) (*request.Request, *voiceid.DeleteDomainOutput) + + DeleteFraudster(*voiceid.DeleteFraudsterInput) (*voiceid.DeleteFraudsterOutput, error) + DeleteFraudsterWithContext(aws.Context, *voiceid.DeleteFraudsterInput, ...request.Option) (*voiceid.DeleteFraudsterOutput, error) + DeleteFraudsterRequest(*voiceid.DeleteFraudsterInput) (*request.Request, *voiceid.DeleteFraudsterOutput) + + DeleteSpeaker(*voiceid.DeleteSpeakerInput) (*voiceid.DeleteSpeakerOutput, error) + DeleteSpeakerWithContext(aws.Context, *voiceid.DeleteSpeakerInput, ...request.Option) (*voiceid.DeleteSpeakerOutput, error) + DeleteSpeakerRequest(*voiceid.DeleteSpeakerInput) (*request.Request, *voiceid.DeleteSpeakerOutput) + + DescribeDomain(*voiceid.DescribeDomainInput) (*voiceid.DescribeDomainOutput, error) + DescribeDomainWithContext(aws.Context, *voiceid.DescribeDomainInput, ...request.Option) (*voiceid.DescribeDomainOutput, error) + DescribeDomainRequest(*voiceid.DescribeDomainInput) (*request.Request, *voiceid.DescribeDomainOutput) + + DescribeFraudster(*voiceid.DescribeFraudsterInput) (*voiceid.DescribeFraudsterOutput, error) + DescribeFraudsterWithContext(aws.Context, *voiceid.DescribeFraudsterInput, ...request.Option) (*voiceid.DescribeFraudsterOutput, error) + DescribeFraudsterRequest(*voiceid.DescribeFraudsterInput) (*request.Request, *voiceid.DescribeFraudsterOutput) + + DescribeFraudsterRegistrationJob(*voiceid.DescribeFraudsterRegistrationJobInput) (*voiceid.DescribeFraudsterRegistrationJobOutput, error) + DescribeFraudsterRegistrationJobWithContext(aws.Context, *voiceid.DescribeFraudsterRegistrationJobInput, ...request.Option) (*voiceid.DescribeFraudsterRegistrationJobOutput, error) + DescribeFraudsterRegistrationJobRequest(*voiceid.DescribeFraudsterRegistrationJobInput) (*request.Request, *voiceid.DescribeFraudsterRegistrationJobOutput) + + DescribeSpeaker(*voiceid.DescribeSpeakerInput) (*voiceid.DescribeSpeakerOutput, error) + DescribeSpeakerWithContext(aws.Context, *voiceid.DescribeSpeakerInput, ...request.Option) (*voiceid.DescribeSpeakerOutput, error) + DescribeSpeakerRequest(*voiceid.DescribeSpeakerInput) (*request.Request, *voiceid.DescribeSpeakerOutput) + + DescribeSpeakerEnrollmentJob(*voiceid.DescribeSpeakerEnrollmentJobInput) (*voiceid.DescribeSpeakerEnrollmentJobOutput, error) + DescribeSpeakerEnrollmentJobWithContext(aws.Context, *voiceid.DescribeSpeakerEnrollmentJobInput, ...request.Option) (*voiceid.DescribeSpeakerEnrollmentJobOutput, error) + DescribeSpeakerEnrollmentJobRequest(*voiceid.DescribeSpeakerEnrollmentJobInput) (*request.Request, *voiceid.DescribeSpeakerEnrollmentJobOutput) + + EvaluateSession(*voiceid.EvaluateSessionInput) (*voiceid.EvaluateSessionOutput, error) + EvaluateSessionWithContext(aws.Context, *voiceid.EvaluateSessionInput, ...request.Option) (*voiceid.EvaluateSessionOutput, error) + EvaluateSessionRequest(*voiceid.EvaluateSessionInput) (*request.Request, *voiceid.EvaluateSessionOutput) + + ListDomains(*voiceid.ListDomainsInput) (*voiceid.ListDomainsOutput, error) + ListDomainsWithContext(aws.Context, *voiceid.ListDomainsInput, ...request.Option) (*voiceid.ListDomainsOutput, error) + ListDomainsRequest(*voiceid.ListDomainsInput) (*request.Request, *voiceid.ListDomainsOutput) + + ListDomainsPages(*voiceid.ListDomainsInput, func(*voiceid.ListDomainsOutput, bool) bool) error + ListDomainsPagesWithContext(aws.Context, *voiceid.ListDomainsInput, func(*voiceid.ListDomainsOutput, bool) bool, ...request.Option) error + + ListFraudsterRegistrationJobs(*voiceid.ListFraudsterRegistrationJobsInput) (*voiceid.ListFraudsterRegistrationJobsOutput, error) + ListFraudsterRegistrationJobsWithContext(aws.Context, *voiceid.ListFraudsterRegistrationJobsInput, ...request.Option) (*voiceid.ListFraudsterRegistrationJobsOutput, error) + ListFraudsterRegistrationJobsRequest(*voiceid.ListFraudsterRegistrationJobsInput) (*request.Request, *voiceid.ListFraudsterRegistrationJobsOutput) + + ListFraudsterRegistrationJobsPages(*voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool) error + ListFraudsterRegistrationJobsPagesWithContext(aws.Context, *voiceid.ListFraudsterRegistrationJobsInput, func(*voiceid.ListFraudsterRegistrationJobsOutput, bool) bool, ...request.Option) error + + ListSpeakerEnrollmentJobs(*voiceid.ListSpeakerEnrollmentJobsInput) (*voiceid.ListSpeakerEnrollmentJobsOutput, error) + ListSpeakerEnrollmentJobsWithContext(aws.Context, *voiceid.ListSpeakerEnrollmentJobsInput, ...request.Option) (*voiceid.ListSpeakerEnrollmentJobsOutput, error) + ListSpeakerEnrollmentJobsRequest(*voiceid.ListSpeakerEnrollmentJobsInput) (*request.Request, *voiceid.ListSpeakerEnrollmentJobsOutput) + + ListSpeakerEnrollmentJobsPages(*voiceid.ListSpeakerEnrollmentJobsInput, func(*voiceid.ListSpeakerEnrollmentJobsOutput, bool) bool) error + ListSpeakerEnrollmentJobsPagesWithContext(aws.Context, *voiceid.ListSpeakerEnrollmentJobsInput, func(*voiceid.ListSpeakerEnrollmentJobsOutput, bool) bool, ...request.Option) error + + ListSpeakers(*voiceid.ListSpeakersInput) (*voiceid.ListSpeakersOutput, error) + ListSpeakersWithContext(aws.Context, *voiceid.ListSpeakersInput, ...request.Option) (*voiceid.ListSpeakersOutput, error) + ListSpeakersRequest(*voiceid.ListSpeakersInput) (*request.Request, *voiceid.ListSpeakersOutput) + + ListSpeakersPages(*voiceid.ListSpeakersInput, func(*voiceid.ListSpeakersOutput, bool) bool) error + ListSpeakersPagesWithContext(aws.Context, *voiceid.ListSpeakersInput, func(*voiceid.ListSpeakersOutput, bool) bool, ...request.Option) error + + ListTagsForResource(*voiceid.ListTagsForResourceInput) (*voiceid.ListTagsForResourceOutput, error) + ListTagsForResourceWithContext(aws.Context, *voiceid.ListTagsForResourceInput, ...request.Option) (*voiceid.ListTagsForResourceOutput, error) + ListTagsForResourceRequest(*voiceid.ListTagsForResourceInput) (*request.Request, *voiceid.ListTagsForResourceOutput) + + OptOutSpeaker(*voiceid.OptOutSpeakerInput) (*voiceid.OptOutSpeakerOutput, error) + OptOutSpeakerWithContext(aws.Context, *voiceid.OptOutSpeakerInput, ...request.Option) (*voiceid.OptOutSpeakerOutput, error) + OptOutSpeakerRequest(*voiceid.OptOutSpeakerInput) (*request.Request, *voiceid.OptOutSpeakerOutput) + + StartFraudsterRegistrationJob(*voiceid.StartFraudsterRegistrationJobInput) (*voiceid.StartFraudsterRegistrationJobOutput, error) + StartFraudsterRegistrationJobWithContext(aws.Context, *voiceid.StartFraudsterRegistrationJobInput, ...request.Option) (*voiceid.StartFraudsterRegistrationJobOutput, error) + StartFraudsterRegistrationJobRequest(*voiceid.StartFraudsterRegistrationJobInput) (*request.Request, *voiceid.StartFraudsterRegistrationJobOutput) + + StartSpeakerEnrollmentJob(*voiceid.StartSpeakerEnrollmentJobInput) (*voiceid.StartSpeakerEnrollmentJobOutput, error) + StartSpeakerEnrollmentJobWithContext(aws.Context, *voiceid.StartSpeakerEnrollmentJobInput, ...request.Option) (*voiceid.StartSpeakerEnrollmentJobOutput, error) + StartSpeakerEnrollmentJobRequest(*voiceid.StartSpeakerEnrollmentJobInput) (*request.Request, *voiceid.StartSpeakerEnrollmentJobOutput) + + TagResource(*voiceid.TagResourceInput) (*voiceid.TagResourceOutput, error) + TagResourceWithContext(aws.Context, *voiceid.TagResourceInput, ...request.Option) (*voiceid.TagResourceOutput, error) + TagResourceRequest(*voiceid.TagResourceInput) (*request.Request, *voiceid.TagResourceOutput) + + UntagResource(*voiceid.UntagResourceInput) (*voiceid.UntagResourceOutput, error) + UntagResourceWithContext(aws.Context, *voiceid.UntagResourceInput, ...request.Option) (*voiceid.UntagResourceOutput, error) + UntagResourceRequest(*voiceid.UntagResourceInput) (*request.Request, *voiceid.UntagResourceOutput) + + UpdateDomain(*voiceid.UpdateDomainInput) (*voiceid.UpdateDomainOutput, error) + UpdateDomainWithContext(aws.Context, *voiceid.UpdateDomainInput, ...request.Option) (*voiceid.UpdateDomainOutput, error) + UpdateDomainRequest(*voiceid.UpdateDomainInput) (*request.Request, *voiceid.UpdateDomainOutput) +} + +var _ VoiceIDAPI = (*voiceid.VoiceID)(nil)