diff --git a/CHANGELOG.md b/CHANGELOG.md index 666d4d1556..fa68a341b9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,20 @@ +Release v1.34.26 (2020-09-17) +=== + +### Service Client Updates +* `service/apigateway`: Updates service API and documentation + * Adds support for mutual TLS authentication for public regional REST Apis +* `service/apigatewayv2`: Updates service API and documentation + * Adds support for mutual TLS authentication and disableAPIExecuteEndpoint for public regional HTTP Apis +* `service/cloudfront`: Updates service documentation + * Documentation updates for CloudFront +* `service/comprehend`: Updates service API and documentation +* `service/es`: Updates service API and documentation + * Adds support for data plane audit logging in Amazon Elasticsearch Service. +* `service/kendra`: Updates service API and documentation + * Amazon Kendra now supports additional file formats and metadata for FAQs. +* `service/transcribe-streaming`: Updates service API and documentation + Release v1.34.25 (2020-09-16) === diff --git a/aws/endpoints/defaults.go b/aws/endpoints/defaults.go index 3cd3cfa926..a2484a9026 100644 --- a/aws/endpoints/defaults.go +++ b/aws/endpoints/defaults.go @@ -349,6 +349,7 @@ var awsPartition = partition{ Protocols: []string{"https"}, }, Endpoints: endpoints{ + "af-south-1": endpoint{}, "ap-east-1": endpoint{}, "ap-northeast-1": endpoint{}, "ap-northeast-2": endpoint{}, @@ -358,6 +359,7 @@ var awsPartition = partition{ "ca-central-1": endpoint{}, "eu-central-1": endpoint{}, "eu-north-1": endpoint{}, + "eu-south-1": endpoint{}, "eu-west-1": endpoint{}, "eu-west-2": endpoint{}, "eu-west-3": endpoint{}, @@ -1250,6 +1252,7 @@ var awsPartition = partition{ "ca-central-1": endpoint{}, "eu-central-1": endpoint{}, "eu-north-1": endpoint{}, + "eu-south-1": endpoint{}, "eu-west-1": endpoint{}, "eu-west-2": endpoint{}, "eu-west-3": endpoint{}, diff --git a/aws/version.go b/aws/version.go index b0d01fb536..e1173b7b50 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.34.25" +const SDKVersion = "1.34.26" diff --git a/models/apis/apigateway/2015-07-09/api-2.json b/models/apis/apigateway/2015-07-09/api-2.json index 5782034b4c..c711e27681 100644 --- a/models/apis/apigateway/2015-07-09/api-2.json +++ b/models/apis/apigateway/2015-07-09/api-2.json @@ -792,6 +792,7 @@ "output":{"shape":"Deployments"}, "errors":[ {"shape":"BadRequestException"}, + {"shape":"NotFoundException"}, {"shape":"UnauthorizedException"}, {"shape":"TooManyRequestsException"}, {"shape":"ServiceUnavailableException"} @@ -2204,7 +2205,8 @@ "regionalCertificateArn":{"shape":"String"}, "endpointConfiguration":{"shape":"EndpointConfiguration"}, "tags":{"shape":"MapOfStringToString"}, - "securityPolicy":{"shape":"SecurityPolicy"} + "securityPolicy":{"shape":"SecurityPolicy"}, + "mutualTlsAuthentication":{"shape":"MutualTlsAuthenticationInput"} } }, "CreateModelRequest":{ @@ -2850,7 +2852,8 @@ "domainNameStatus":{"shape":"DomainNameStatus"}, "domainNameStatusMessage":{"shape":"String"}, "securityPolicy":{"shape":"SecurityPolicy"}, - "tags":{"shape":"MapOfStringToString"} + "tags":{"shape":"MapOfStringToString"}, + "mutualTlsAuthentication":{"shape":"MutualTlsAuthentication"} } }, "DomainNameStatus":{ @@ -4291,6 +4294,21 @@ } } }, + "MutualTlsAuthentication":{ + "type":"structure", + "members":{ + "truststoreUri":{"shape":"String"}, + "truststoreVersion":{"shape":"String"}, + "truststoreWarnings":{"shape":"ListOfString"} + } + }, + "MutualTlsAuthenticationInput":{ + "type":"structure", + "members":{ + "truststoreUri":{"shape":"String"}, + "truststoreVersion":{"shape":"String"} + } + }, "NotFoundException":{ "type":"structure", "members":{ diff --git a/models/apis/apigateway/2015-07-09/docs-2.json b/models/apis/apigateway/2015-07-09/docs-2.json index 5f8557d0bc..a5a9538292 100644 --- a/models/apis/apigateway/2015-07-09/docs-2.json +++ b/models/apis/apigateway/2015-07-09/docs-2.json @@ -1083,6 +1083,7 @@ "Integration$cacheKeyParameters": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

", "MapOfStringToList$value": null, "Method$authorizationScopes": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", + "MutualTlsAuthentication$truststoreWarnings": "

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

", "PutIntegrationRequest$cacheKeyParameters": "

A list of request parameters whose values API Gateway caches. To be valid values for cacheKeyParameters, these parameters must also be specified for Method requestParameters.

", "PutMethodRequest$authorizationScopes": "

A list of authorization scopes configured on the method. The scopes are used with a COGNITO_USER_POOLS authorizer to authorize the method invocation. The authorization works by matching the method scopes against the scopes parsed from the access token in the incoming request. The method invocation is authorized if any method scopes matches a claimed scope in the access token. Otherwise, the invocation is not authorized. When the method scope is configured, the client must provide an access token instead of an identity token for authorization purposes.

", "RestApi$warnings": "

The warning messages reported when failonwarnings is turned on during API import.

", @@ -1277,6 +1278,18 @@ "refs": { } }, + "MutualTlsAuthentication": { + "base": "

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.

", + "refs": { + "DomainName$mutualTlsAuthentication": "

The mutual TLS authentication configuration for a custom domain name. If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

" + } + }, + "MutualTlsAuthenticationInput": { + "base": "

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your custom domain name.

", + "refs": { + "CreateDomainNameRequest$mutualTlsAuthentication": null + } + }, "NotFoundException": { "base": "

The requested resource is not found. Make sure that the request URI is correct.

", "refs": { @@ -1787,6 +1800,10 @@ "Model$schema": "

The schema for the model. For application/json models, this should be JSON schema draft 4 model. Do not include \"\\*/\" characters in the description of any properties because such \"\\*/\" characters may be interpreted as the closing marker for comments in some languages, such as Java or JavaScript, causing the installation of your API's SDK generated by API Gateway to fail.

", "Model$contentType": "

The content-type for the model.

", "Models$position": null, + "MutualTlsAuthentication$truststoreUri": "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "MutualTlsAuthentication$truststoreVersion": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "MutualTlsAuthenticationInput$truststoreUri": "

An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "MutualTlsAuthenticationInput$truststoreVersion": "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", "NotFoundException$message": null, "PatchOperation$path": "

The op operation's target, as identified by a JSON Pointer value that references a location within the targeted resource. For example, if the target resource has an updateable property of {\"name\":\"value\"}, the path for this property is /name. If the name property value is a JSON object (e.g., {\"name\": {\"child/name\": \"child-value\"}}), the path for the child/name property will be /name/child~1name. Any slash (\"/\") character appearing in path names must be escaped with \"~1\", as shown in the example above. Each op operation can have only one path associated with it.

", "PatchOperation$value": "

The new target value of the update operation. It is applicable for the add or replace operation. When using AWS CLI to update a property of a JSON value, enclose the JSON object with a pair of single quotes in a Linux shell, e.g., '{\"a\": ...}'. In a Windows shell, see Using JSON for Parameters.

", diff --git a/models/apis/apigatewayv2/2018-11-29/api-2.json b/models/apis/apigatewayv2/2018-11-29/api-2.json index 119abe3c16..568886c653 100644 --- a/models/apis/apigatewayv2/2018-11-29/api-2.json +++ b/models/apis/apigatewayv2/2018-11-29/api-2.json @@ -1531,6 +1531,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -1794,6 +1798,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "Name" : { "shape" : "StringWithLengthBetween1And128", "locationName" : "name" @@ -1910,6 +1918,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "Name" : { "shape" : "StringWithLengthBetween1And128", "locationName" : "name" @@ -1976,6 +1988,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -2224,6 +2240,10 @@ "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthenticationInput", + "locationName" : "mutualTlsAuthentication" + }, "Tags" : { "shape" : "Tags", "locationName" : "tags" @@ -2242,6 +2262,10 @@ "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthenticationInput", + "locationName" : "mutualTlsAuthentication" + }, "Tags" : { "shape" : "Tags", "locationName" : "tags" @@ -2263,6 +2287,10 @@ "DomainNameConfigurations" : { "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" + }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthentication", + "locationName" : "mutualTlsAuthentication" }, "Tags" : { "shape" : "Tags", @@ -3466,6 +3494,10 @@ "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthentication", + "locationName" : "mutualTlsAuthentication" + }, "Tags" : { "shape" : "Tags", "locationName" : "tags" @@ -3724,6 +3756,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -3986,6 +4022,10 @@ "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthentication", + "locationName" : "mutualTlsAuthentication" + }, "Tags" : { "shape" : "Tags", "locationName" : "tags" @@ -4817,6 +4857,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -5080,6 +5124,37 @@ "locationName" : "nextToken" } } + } + , + "MutualTlsAuthentication" : { + "type" : "structure", + "members" : { + "TruststoreUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "truststoreUri" + }, + "TruststoreVersion" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "truststoreVersion" + }, + "TruststoreWarnings" : { + "shape" : "__listOf__string", + "locationName" : "truststoreWarnings" + } + } + }, + "MutualTlsAuthenticationInput" : { + "type" : "structure", + "members" : { + "TruststoreUri" : { + "shape" : "UriWithLengthBetween1And2048", + "locationName" : "truststoreUri" + }, + "TruststoreVersion" : { + "shape" : "StringWithLengthBetween1And64", + "locationName" : "truststoreVersion" + } + } }, "NextToken" : { "type" : "string" @@ -5188,6 +5263,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -5642,6 +5721,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "Name" : { "shape" : "StringWithLengthBetween1And128", "locationName" : "name" @@ -5758,6 +5841,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "Name" : { "shape" : "StringWithLengthBetween1And128", "locationName" : "name" @@ -5816,6 +5903,10 @@ "shape" : "__boolean", "locationName" : "disableSchemaValidation" }, + "DisableExecuteApiEndpoint" : { + "shape" : "__boolean", + "locationName" : "disableExecuteApiEndpoint" + }, "ImportInfo" : { "shape" : "__listOf__string", "locationName" : "importInfo" @@ -6060,6 +6151,10 @@ "DomainNameConfigurations" : { "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" + }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthenticationInput", + "locationName" : "mutualTlsAuthentication" } } }, @@ -6074,6 +6169,10 @@ "DomainNameConfigurations" : { "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" + }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthenticationInput", + "locationName" : "mutualTlsAuthentication" } }, "required" : [ "DomainName" ] @@ -6093,6 +6192,10 @@ "shape" : "DomainNameConfigurations", "locationName" : "domainNameConfigurations" }, + "MutualTlsAuthentication" : { + "shape" : "MutualTlsAuthentication", + "locationName" : "mutualTlsAuthentication" + }, "Tags" : { "shape" : "Tags", "locationName" : "tags" diff --git a/models/apis/apigatewayv2/2018-11-29/docs-2.json b/models/apis/apigatewayv2/2018-11-29/docs-2.json index 7cf0e22095..40c229761a 100644 --- a/models/apis/apigatewayv2/2018-11-29/docs-2.json +++ b/models/apis/apigatewayv2/2018-11-29/docs-2.json @@ -443,6 +443,19 @@ "base" : "

Represents a collection of data models. See Create Models and Mapping Templates for Request and Response Mappings.

", "refs" : { } }, + "MutualTlsAuthentication" : { + "base" : "

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

", + "refs" : { + "DomainName$MutualTlsAuthentication" : "

The mutual TLS authentication configuration for a custom domain name.

" + } + }, + "MutualTlsAuthenticationInput" : { + "base" : "

If specified, API Gateway performs two-way authentication between the client and the server. Clients must present a trusted certificate to access your API.

", + "refs" : { + "CreateDomainNameInput$MutualTlsAuthentication" : "

The mutual TLS authentication configuration for a custom domain name.

", + "UpdateDomainNameInput$MutualTlsAuthentication" : "

The mutual TLS authentication configuration for a custom domain name.

" + } + }, "NextToken" : { "base" : "

The next page of elements from this collection. Not valid for the last element of the collection.

", "refs" : { @@ -743,6 +756,8 @@ "CreateRouteInput$OperationName" : "

The operation name for the route.

", "Integration$IntegrationMethod" : "

Specifies the integration's HTTP method type.

", "Integration$PayloadFormatVersion" : "

Specifies the format of the payload sent to an integration. Required for HTTP APIs.

", + "MutualTlsAuthentication$TruststoreVersion" : "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", + "MutualTlsAuthenticationInput$TruststoreVersion" : "

The version of the S3 object that contains your truststore. To specify a version, you must have versioning enabled for the S3 bucket.

", "Route$OperationName" : "

The operation name for the route.

", "UpdateApiInput$Version" : "

A version identifier for the API.

", "UpdateAuthorizerInput$AuthorizerPayloadFormatVersion" : "

Specifies the format of the payload sent to an HTTP API Lambda authorizer. Required for HTTP API Lambda authorizers. Supported values are 1.0 and 2.0. To learn more, see Working with AWS Lambda authorizers for HTTP APIs.

", @@ -865,6 +880,8 @@ "CreateIntegrationInput$IntegrationUri" : "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", "Integration$IntegrationUri" : "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

", "JWTConfiguration$Issuer" : "

The base domain of the identity provider that issues JSON Web Tokens. For example, an Amazon Cognito user pool has the following format: https://cognito-idp.{region}.amazonaws.com/{userPoolId}\n . Required for the JWT authorizer type. Supported only for HTTP APIs.

", + "MutualTlsAuthentication$TruststoreUri" : "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", + "MutualTlsAuthenticationInput$TruststoreUri" : "

An Amazon S3 URL that specifies the truststore for mutual TLS authentication, for example, s3://bucket-name/key-name. The truststore can contain certificates from public or private certificate authorities. To update the truststore, upload a new version to S3, and then update your custom domain name to use the new version. To update the truststore, you must have permissions to access the S3 object.

", "UpdateApiInput$Target" : "

This property is part of quick create. For HTTP integrations, specify a fully qualified URL. For Lambda integrations, specify a function ARN. The type of the integration will be HTTP_PROXY or AWS_PROXY, respectively. The value provided updates the integration URI and integration type. You can update a quick-created target, but you can't remove it from an API. Supported only for HTTP APIs.

", "UpdateAuthorizerInput$AuthorizerUri" : "

The authorizer's Uniform Resource Identifier (URI). For REQUEST authorizers, this must be a well-formed Lambda function URI, for example, arn:aws:apigateway:us-west-2:lambda:path/2015-03-31/functions/arn:aws:lambda:us-west-2:{account_id}:function:{lambda_function_name}/invocations. In general, the URI has this form: arn:aws:apigateway:{region}:lambda:path/{service_api}\n , where {region} is the same as the region hosting the Lambda function, path indicates that the remaining substring in the URI should be treated as the path to the resource, including the initial /. For Lambda functions, this is usually of the form /2015-03-31/functions/[FunctionARN]/invocations. Supported only for REQUEST authorizers.

", "UpdateIntegrationInput$IntegrationUri" : "

For a Lambda integration, specify the URI of a Lambda function.

For an HTTP integration, specify a fully-qualified URL.

For an HTTP API private integration, specify the ARN of an Application Load Balancer listener, Network Load Balancer listener, or AWS Cloud Map service. If you specify the ARN of an AWS Cloud Map service, API Gateway uses DiscoverInstances to identify resources. You can use query parameters to target specific resources. To learn more, see DiscoverInstances. For private integrations, all resources must be owned by the same AWS account.

" @@ -898,6 +915,7 @@ "Api$ApiGatewayManaged" : "

Specifies whether an API is managed by API Gateway. You can't update or delete a managed API by using API Gateway. A managed API can be deleted only through the tooling or service that created it.

", "Api$DisableSchemaValidation" : "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", "Authorizer$EnableSimpleResponses" : "

Specifies whether a Lambda authorizer returns a response in a simple format. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", + "Api$DisableExecuteApiEndpoint" : "

Specifies whether clients can invoke your API by using the default execute-api endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com endpoint. To require that clients use a custom domain name to invoke your API, disable the default endpoint.

", "Cors$AllowCredentials" : "

Specifies whether credentials are included in the CORS request. Supported only for HTTP APIs.

", "CreateApiInput$DisableSchemaValidation" : "

Avoid validating models when creating a deployment. Supported only for WebSocket APIs.

", "CreateAuthorizerInput$EnableSimpleResponses" : "

Specifies whether a Lambda authorizer returns a response in a simple format. By default, a Lambda authorizer must return an IAM policy. If enabled, the Lambda authorizer can return a boolean value instead of an IAM policy. Supported only for HTTP APIs. To learn more, see Working with AWS Lambda authorizers for HTTP APIs

", @@ -1007,7 +1025,8 @@ "refs" : { "Api$ImportInfo" : "

The validation information during API import. This may include particular properties of your OpenAPI definition which are ignored during import. Supported only for HTTP APIs.

", "Api$Warnings" : "

The warning messages reported when failonwarnings is turned on during API import.

", - "JWTConfiguration$Audience" : "

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

" + "JWTConfiguration$Audience" : "

A list of the intended recipients of the JWT. A valid JWT must provide an aud that matches at least one entry in this list. See RFC 7519. Supported only for HTTP APIs.

", + "MutualTlsAuthentication$TruststoreWarnings" : "

A list of warnings that API Gateway returns while processing your truststore. Invalid certificates produce warnings. Mutual TLS is still enabled, but some clients might not be able to access your API. To resolve warnings, upload a new truststore to S3, and then update you domain name to use the new version.

" } }, "__string" : { diff --git a/models/apis/cloudfront/2020-05-31/docs-2.json b/models/apis/cloudfront/2020-05-31/docs-2.json index cb81ce559a..e39b43124e 100644 --- a/models/apis/cloudfront/2020-05-31/docs-2.json +++ b/models/apis/cloudfront/2020-05-31/docs-2.json @@ -1714,7 +1714,7 @@ "PriceClass": { "base": null, "refs": { - "DistributionConfig$PriceClass": "

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing. For price class information, scroll down to see the table at the bottom of the page.

", + "DistributionConfig$PriceClass": "

The price class that corresponds with the maximum price that you want to pay for CloudFront service. If you specify PriceClass_All, CloudFront responds to requests for your objects from all CloudFront edge locations.

If you specify a price class other than PriceClass_All, CloudFront serves your objects from the CloudFront edge location that has the lowest latency among the edge locations in your price class. Viewers who are in or near regions that are excluded from your specified price class may encounter slower performance.

For more information about price classes, see Choosing the Price Class for a CloudFront Distribution in the Amazon CloudFront Developer Guide. For information about CloudFront pricing, including how price classes (such as Price Class 100) map to CloudFront regions, see Amazon CloudFront Pricing.

", "DistributionSummary$PriceClass": "

A complex type that contains information about price class for this streaming distribution.

", "StreamingDistributionConfig$PriceClass": "

A complex type that contains information about price class for this streaming distribution.

", "StreamingDistributionSummary$PriceClass": "

A complex type that contains information about price class for this streaming distribution.

" @@ -2372,8 +2372,8 @@ "LambdaFunctionAssociation$IncludeBody": "

A flag that allows a Lambda function to have read access to the body content. For more information, see Accessing the Request Body by Choosing the Include Body Option in the Amazon CloudFront Developer Guide.

", "LoggingConfig$Enabled": "

Specifies whether you want CloudFront to save access logs to an Amazon S3 bucket. If you don't want to enable logging when you create a distribution or if you want to disable logging for an existing distribution, specify false for Enabled, and specify empty Bucket and Prefix elements. If you specify false for Enabled but you specify values for Bucket, prefix, and IncludeCookies, the values are automatically deleted.

", "LoggingConfig$IncludeCookies": "

Specifies whether you want CloudFront to include cookies in access logs, specify true for IncludeCookies. If you choose to include cookies in logs, CloudFront logs all cookies regardless of how you configure the cache behaviors for this distribution. If you don't want to include cookies when you create a distribution or if you want to disable include cookies for an existing distribution, specify false for IncludeCookies.

", - "ParametersInCacheKeyAndForwardedToOrigin$EnableAcceptEncodingGzip": "

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

If one or both of these fields are true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.

For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

", - "ParametersInCacheKeyAndForwardedToOrigin$EnableAcceptEncodingBrotli": "

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

If one or both of these fields are true, you should not whitelist the Accept-Encoding header in the cache policy or in an origin request policy attached to the same cache behavior.

For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

", + "ParametersInCacheKeyAndForwardedToOrigin$EnableAcceptEncodingGzip": "

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingBrotli field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

", + "ParametersInCacheKeyAndForwardedToOrigin$EnableAcceptEncodingBrotli": "

A flag that can affect whether the Accept-Encoding HTTP header is included in the cache key and included in requests that CloudFront sends to the origin.

This field is related to the EnableAcceptEncodingGzip field. If one or both of these fields is true and the viewer request includes the Accept-Encoding header, then CloudFront does the following:

For more information, see Cache compressed objects in the Amazon CloudFront Developer Guide.

If you set this value to true, and this cache behavior also has an origin request policy attached, do not include the Accept-Encoding header in the origin request policy. CloudFront always includes the Accept-Encoding header in origin requests when the value of this field is true, so including this header in an origin request policy has no effect.

If both of these fields are false, then CloudFront treats the Accept-Encoding header the same as any other HTTP header in the viewer request. By default, it’s not included in the cache key and it’s not included in origin requests. In this case, you can manually add Accept-Encoding to the headers whitelist like any other HTTP header.

", "QueryArgProfileConfig$ForwardWhenQueryArgProfileIsUnknown": "

Flag to set if you want a request to be forwarded to the origin even if the profile specified by the field-level encryption query argument, fle-profile, is unknown.

", "RealtimeLogConfigs$IsTruncated": "

A flag that indicates whether there are more real-time log configurations than are contained in this list.

", "StreamingDistributionConfig$Enabled": "

Whether the streaming distribution is enabled to accept user requests for content.

", diff --git a/models/apis/comprehend/2017-11-27/api-2.json b/models/apis/comprehend/2017-11-27/api-2.json index 7bd5043553..e0789698d2 100644 --- a/models/apis/comprehend/2017-11-27/api-2.json +++ b/models/apis/comprehend/2017-11-27/api-2.json @@ -319,6 +319,21 @@ {"shape":"InternalServerException"} ] }, + "DescribePiiEntitiesDetectionJob":{ + "name":"DescribePiiEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DescribePiiEntitiesDetectionJobRequest"}, + "output":{"shape":"DescribePiiEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InternalServerException"} + ] + }, "DescribeSentimentDetectionJob":{ "name":"DescribeSentimentDetectionJob", "http":{ @@ -394,6 +409,21 @@ {"shape":"InternalServerException"} ] }, + "DetectPiiEntities":{ + "name":"DetectPiiEntities", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"DetectPiiEntitiesRequest"}, + "output":{"shape":"DetectPiiEntitiesResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TextSizeLimitExceededException"}, + {"shape":"UnsupportedLanguageException"}, + {"shape":"InternalServerException"} + ] + }, "DetectSentiment":{ "name":"DetectSentiment", "http":{ @@ -528,6 +558,21 @@ {"shape":"InternalServerException"} ] }, + "ListPiiEntitiesDetectionJobs":{ + "name":"ListPiiEntitiesDetectionJobs", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"ListPiiEntitiesDetectionJobsRequest"}, + "output":{"shape":"ListPiiEntitiesDetectionJobsResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"InvalidFilterException"}, + {"shape":"InternalServerException"} + ] + }, "ListSentimentDetectionJobs":{ "name":"ListSentimentDetectionJobs", "http":{ @@ -636,6 +681,21 @@ {"shape":"InternalServerException"} ] }, + "StartPiiEntitiesDetectionJob":{ + "name":"StartPiiEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StartPiiEntitiesDetectionJobRequest"}, + "output":{"shape":"StartPiiEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"TooManyRequestsException"}, + {"shape":"KmsKeyValidationException"}, + {"shape":"InternalServerException"} + ] + }, "StartSentimentDetectionJob":{ "name":"StartSentimentDetectionJob", "http":{ @@ -708,6 +768,20 @@ {"shape":"InternalServerException"} ] }, + "StopPiiEntitiesDetectionJob":{ + "name":"StopPiiEntitiesDetectionJob", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopPiiEntitiesDetectionJobRequest"}, + "output":{"shape":"StopPiiEntitiesDetectionJobResponse"}, + "errors":[ + {"shape":"InvalidRequestException"}, + {"shape":"JobNotFoundException"}, + {"shape":"InternalServerException"} + ] + }, "StopSentimentDetectionJob":{ "name":"StopSentimentDetectionJob", "http":{ @@ -1270,6 +1344,19 @@ "KeyPhrasesDetectionJobProperties":{"shape":"KeyPhrasesDetectionJobProperties"} } }, + "DescribePiiEntitiesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + } + }, + "DescribePiiEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "PiiEntitiesDetectionJobProperties":{"shape":"PiiEntitiesDetectionJobProperties"} + } + }, "DescribeSentimentDetectionJobRequest":{ "type":"structure", "required":["JobId"], @@ -1344,6 +1431,23 @@ }, "sensitive":true }, + "DetectPiiEntitiesRequest":{ + "type":"structure", + "required":[ + "Text", + "LanguageCode" + ], + "members":{ + "Text":{"shape":"String"}, + "LanguageCode":{"shape":"LanguageCode"} + } + }, + "DetectPiiEntitiesResponse":{ + "type":"structure", + "members":{ + "Entities":{"shape":"ListOfPiiEntities"} + } + }, "DetectSentimentRequest":{ "type":"structure", "required":[ @@ -2042,10 +2146,33 @@ "type":"list", "member":{"shape":"DocumentLabel"} }, + "ListOfPiiEntities":{ + "type":"list", + "member":{"shape":"PiiEntity"} + }, + "ListOfPiiEntityTypes":{ + "type":"list", + "member":{"shape":"PiiEntityType"} + }, "ListOfSyntaxTokens":{ "type":"list", "member":{"shape":"SyntaxToken"} }, + "ListPiiEntitiesDetectionJobsRequest":{ + "type":"structure", + "members":{ + "Filter":{"shape":"PiiEntitiesDetectionJobFilter"}, + "NextToken":{"shape":"String"}, + "MaxResults":{"shape":"MaxResultsInteger"} + } + }, + "ListPiiEntitiesDetectionJobsResponse":{ + "type":"structure", + "members":{ + "PiiEntitiesDetectionJobPropertiesList":{"shape":"PiiEntitiesDetectionJobPropertiesList"}, + "NextToken":{"shape":"String"} + } + }, "ListSentimentDetectionJobsRequest":{ "type":"structure", "members":{ @@ -2090,6 +2217,12 @@ "NextToken":{"shape":"String"} } }, + "MaskCharacter":{ + "type":"string", + "max":1, + "min":1, + "pattern":"[!@#$%&*]" + }, "MaxResultsInteger":{ "type":"integer", "max":500, @@ -2150,6 +2283,103 @@ "VERB" ] }, + "PiiEntitiesDetectionJobFilter":{ + "type":"structure", + "members":{ + "JobName":{"shape":"JobName"}, + "JobStatus":{"shape":"JobStatus"}, + "SubmitTimeBefore":{"shape":"Timestamp"}, + "SubmitTimeAfter":{"shape":"Timestamp"} + } + }, + "PiiEntitiesDetectionJobProperties":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobName":{"shape":"JobName"}, + "JobStatus":{"shape":"JobStatus"}, + "Message":{"shape":"AnyLengthString"}, + "SubmitTime":{"shape":"Timestamp"}, + "EndTime":{"shape":"Timestamp"}, + "InputDataConfig":{"shape":"InputDataConfig"}, + "OutputDataConfig":{"shape":"PiiOutputDataConfig"}, + "RedactionConfig":{"shape":"RedactionConfig"}, + "LanguageCode":{"shape":"LanguageCode"}, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "Mode":{"shape":"PiiEntitiesDetectionMode"} + } + }, + "PiiEntitiesDetectionJobPropertiesList":{ + "type":"list", + "member":{"shape":"PiiEntitiesDetectionJobProperties"} + }, + "PiiEntitiesDetectionMaskMode":{ + "type":"string", + "enum":[ + "MASK", + "REPLACE_WITH_PII_ENTITY_TYPE" + ] + }, + "PiiEntitiesDetectionMode":{ + "type":"string", + "enum":[ + "ONLY_REDACTION", + "ONLY_OFFSETS" + ] + }, + "PiiEntity":{ + "type":"structure", + "members":{ + "Score":{"shape":"Float"}, + "Type":{"shape":"PiiEntityType"}, + "BeginOffset":{"shape":"Integer"}, + "EndOffset":{"shape":"Integer"} + } + }, + "PiiEntityType":{ + "type":"string", + "enum":[ + "BANK_ACCOUNT_NUMBER", + "BANK_ROUTING", + "CREDIT_DEBIT_NUMBER", + "CREDIT_DEBIT_CVV", + "CREDIT_DEBIT_EXPIRY", + "PIN", + "EMAIL", + "ADDRESS", + "NAME", + "PHONE", + "SSN", + "DATE_TIME", + "PASSPORT_NUMBER", + "DRIVER_ID", + "URL", + "AGE", + "USERNAME", + "PASSWORD", + "AWS_ACCESS_KEY", + "AWS_SECRET_KEY", + "IP_ADDRESS", + "MAC_ADDRESS", + "ALL" + ] + }, + "PiiOutputDataConfig":{ + "type":"structure", + "required":["S3Uri"], + "members":{ + "S3Uri":{"shape":"S3Uri"}, + "KmsKeyId":{"shape":"KmsKeyId"} + } + }, + "RedactionConfig":{ + "type":"structure", + "members":{ + "PiiEntityTypes":{"shape":"ListOfPiiEntityTypes"}, + "MaskMode":{"shape":"PiiEntitiesDetectionMaskMode"}, + "MaskCharacter":{"shape":"MaskCharacter"} + } + }, "ResourceInUseException":{ "type":"structure", "members":{ @@ -2358,6 +2588,36 @@ "JobStatus":{"shape":"JobStatus"} } }, + "StartPiiEntitiesDetectionJobRequest":{ + "type":"structure", + "required":[ + "InputDataConfig", + "OutputDataConfig", + "Mode", + "DataAccessRoleArn", + "LanguageCode" + ], + "members":{ + "InputDataConfig":{"shape":"InputDataConfig"}, + "OutputDataConfig":{"shape":"OutputDataConfig"}, + "Mode":{"shape":"PiiEntitiesDetectionMode"}, + "RedactionConfig":{"shape":"RedactionConfig"}, + "DataAccessRoleArn":{"shape":"IamRoleArn"}, + "JobName":{"shape":"JobName"}, + "LanguageCode":{"shape":"LanguageCode"}, + "ClientRequestToken":{ + "shape":"ClientRequestTokenString", + "idempotencyToken":true + } + } + }, + "StartPiiEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobStatus":{"shape":"JobStatus"} + } + }, "StartSentimentDetectionJobRequest":{ "type":"structure", "required":[ @@ -2457,6 +2717,20 @@ "JobStatus":{"shape":"JobStatus"} } }, + "StopPiiEntitiesDetectionJobRequest":{ + "type":"structure", + "required":["JobId"], + "members":{ + "JobId":{"shape":"JobId"} + } + }, + "StopPiiEntitiesDetectionJobResponse":{ + "type":"structure", + "members":{ + "JobId":{"shape":"JobId"}, + "JobStatus":{"shape":"JobStatus"} + } + }, "StopSentimentDetectionJobRequest":{ "type":"structure", "required":["JobId"], diff --git a/models/apis/comprehend/2017-11-27/docs-2.json b/models/apis/comprehend/2017-11-27/docs-2.json index 908eacddfc..394de33285 100644 --- a/models/apis/comprehend/2017-11-27/docs-2.json +++ b/models/apis/comprehend/2017-11-27/docs-2.json @@ -21,11 +21,13 @@ "DescribeEntitiesDetectionJob": "

Gets the properties associated with an entities detection job. Use this operation to get the status of a detection job.

", "DescribeEntityRecognizer": "

Provides details about an entity recognizer including status, S3 buckets containing training data, recognizer metadata, metrics, and so on.

", "DescribeKeyPhrasesDetectionJob": "

Gets the properties associated with a key phrases detection job. Use this operation to get the status of a detection job.

", + "DescribePiiEntitiesDetectionJob": "

Gets the properties associated with a PII entities detection job. For example, you can use this operation to get the job status.

", "DescribeSentimentDetectionJob": "

Gets the properties associated with a sentiment detection job. Use this operation to get the status of a detection job.

", "DescribeTopicsDetectionJob": "

Gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.

", "DetectDominantLanguage": "

Determines the dominant language of the input text. For a list of languages that Amazon Comprehend can detect, see Amazon Comprehend Supported Languages.

", "DetectEntities": "

Inspects text for named entities, and returns information about them. For more information, about named entities, see how-entities.

", "DetectKeyPhrases": "

Detects the key noun phrases found in the text.

", + "DetectPiiEntities": "

Inspects the input text for entities that contain personally identifiable information (PII) and returns information about them.

", "DetectSentiment": "

Inspects text and returns an inference of the prevailing sentiment (POSITIVE, NEUTRAL, MIXED, or NEGATIVE).

", "DetectSyntax": "

Inspects text for syntax and the part of speech of words in the document. For more information, how-syntax.

", "ListDocumentClassificationJobs": "

Gets a list of the documentation classification jobs that you have submitted.

", @@ -35,6 +37,7 @@ "ListEntitiesDetectionJobs": "

Gets a list of the entity detection jobs that you have submitted.

", "ListEntityRecognizers": "

Gets a list of the properties of all entity recognizers that you created, including recognizers currently in training. Allows you to filter the list of recognizers based on criteria such as status and submission time. This call returns up to 500 entity recognizers in the list, with a default number of 100 recognizers in the list.

The results of this list are not in any particular order. Please get the list and sort locally if needed.

", "ListKeyPhrasesDetectionJobs": "

Get a list of key phrase detection jobs that you have submitted.

", + "ListPiiEntitiesDetectionJobs": "

Gets a list of the PII entity detection jobs that you have submitted.

", "ListSentimentDetectionJobs": "

Gets a list of sentiment detection jobs that you have submitted.

", "ListTagsForResource": "

Lists all tags associated with a given Amazon Comprehend resource.

", "ListTopicsDetectionJobs": "

Gets a list of the topic detection jobs that you have submitted.

", @@ -42,11 +45,13 @@ "StartDominantLanguageDetectionJob": "

Starts an asynchronous dominant language detection job for a collection of documents. Use the operation to track the status of a job.

", "StartEntitiesDetectionJob": "

Starts an asynchronous entity detection job for a collection of documents. Use the operation to track the status of a job.

This API can be used for either standard entity detection or custom entity recognition. In order to be used for custom entity recognition, the optional EntityRecognizerArn must be used in order to provide access to the recognizer being used to detect the custom entity.

", "StartKeyPhrasesDetectionJob": "

Starts an asynchronous key phrase detection job for a collection of documents. Use the operation to track the status of a job.

", + "StartPiiEntitiesDetectionJob": "

Starts an asynchronous PII entity detection job for a collection of documents.

", "StartSentimentDetectionJob": "

Starts an asynchronous sentiment detection job for a collection of documents. use the operation to track the status of a job.

", "StartTopicsDetectionJob": "

Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob operation to track the status of a job.

", "StopDominantLanguageDetectionJob": "

Stops a dominant language detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

", "StopEntitiesDetectionJob": "

Stops an entities detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

", "StopKeyPhrasesDetectionJob": "

Stops a key phrases detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

", + "StopPiiEntitiesDetectionJob": "

Stops a PII entities detection job in progress.

", "StopSentimentDetectionJob": "

Stops a sentiment detection job in progress.

If the job state is IN_PROGRESS the job is marked for termination and put into the STOP_REQUESTED state. If the job completes before it can be stopped, it is put into the COMPLETED state; otherwise the job is be stopped and put into the STOPPED state.

If the job is in the COMPLETED or FAILED state when you call the StopDominantLanguageDetectionJob operation, the operation returns a 400 Internal Request Exception.

When a job is stopped, any documents already processed are written to the output location.

", "StopTrainingDocumentClassifier": "

Stops a document classifier training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and put into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

", "StopTrainingEntityRecognizer": "

Stops an entity recognizer training job while in progress.

If the training job state is TRAINING, the job is marked for termination and put into the STOP_REQUESTED state. If the training job completes before it can be stopped, it is put into the TRAINED; otherwise the training job is stopped and putted into the STOPPED state and the service sends back an HTTP 200 response with an empty HTTP body.

", @@ -66,6 +71,7 @@ "EntityRecognizerMetadataEntityTypesListItem$Type": "

Type of entity from the list of entity types in the metadata of an entity recognizer.

", "EntityRecognizerProperties$Message": "

A description of the status of the recognizer.

", "KeyPhrasesDetectionJobProperties$Message": "

A description of the status of a job.

", + "PiiEntitiesDetectionJobProperties$Message": "

A description of the status of a job.

", "SentimentDetectionJobProperties$Message": "

A description of the status of a job.

", "TopicsDetectionJobProperties$Message": "

A description for the status of a job.

" } @@ -203,6 +209,7 @@ "StartDominantLanguageDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

", "StartEntitiesDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", "StartKeyPhrasesDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", + "StartPiiEntitiesDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", "StartSentimentDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you don't set the client request token, Amazon Comprehend generates one.

", "StartTopicsDetectionJobRequest$ClientRequestToken": "

A unique identifier for the request. If you do not set the client request token, Amazon Comprehend generates one.

" } @@ -404,6 +411,16 @@ "refs": { } }, + "DescribePiiEntitiesDetectionJobRequest": { + "base": null, + "refs": { + } + }, + "DescribePiiEntitiesDetectionJobResponse": { + "base": null, + "refs": { + } + }, "DescribeSentimentDetectionJobRequest": { "base": null, "refs": { @@ -454,6 +471,16 @@ "refs": { } }, + "DetectPiiEntitiesRequest": { + "base": null, + "refs": { + } + }, + "DetectPiiEntitiesResponse": { + "base": null, + "refs": { + } + }, "DetectSentimentRequest": { "base": null, "refs": { @@ -783,6 +810,7 @@ "Entity$Score": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

", "KeyPhrase$Score": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

", "PartOfSpeechTag$Score": "

The confidence that Amazon Comprehend has that the part of speech was correctly identified.

", + "PiiEntity$Score": "

The level of confidence that Amazon Comprehend has in the accuracy of the detection.

", "SentimentScore$Positive": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the POSITIVE sentiment.

", "SentimentScore$Negative": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEGATIVE sentiment.

", "SentimentScore$Neutral": "

The level of confidence that Amazon Comprehend has in the accuracy of its detection of the NEUTRAL sentiment.

", @@ -800,11 +828,13 @@ "EntitiesDetectionJobProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

", "EntityRecognizerProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your input data.

", "KeyPhrasesDetectionJobProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

", + "PiiEntitiesDetectionJobProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

", "SentimentDetectionJobProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to your input data.

", "StartDocumentClassificationJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

", "StartDominantLanguageDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "StartEntitiesDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "StartKeyPhrasesDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", + "StartPiiEntitiesDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data.

", "StartSentimentDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "StartTopicsDetectionJobRequest$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that grants Amazon Comprehend read access to your input data. For more information, see https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions.html#auth-role-permissions.

", "TopicsDetectionJobProperties$DataAccessRoleArn": "

The Amazon Resource Name (ARN) of the AWS Identity and Management (IAM) role that grants Amazon Comprehend read access to your job data.

" @@ -826,11 +856,13 @@ "DominantLanguageDetectionJobProperties$InputDataConfig": "

The input data configuration that you supplied when you created the dominant language detection job.

", "EntitiesDetectionJobProperties$InputDataConfig": "

The input data configuration that you supplied when you created the entities detection job.

", "KeyPhrasesDetectionJobProperties$InputDataConfig": "

The input data configuration that you supplied when you created the key phrases detection job.

", + "PiiEntitiesDetectionJobProperties$InputDataConfig": "

The input properties for a PII entities detection job.

", "SentimentDetectionJobProperties$InputDataConfig": "

The input data configuration that you supplied when you created the sentiment detection job.

", "StartDocumentClassificationJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", "StartDominantLanguageDetectionJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", "StartEntitiesDetectionJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", "StartKeyPhrasesDetectionJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", + "StartPiiEntitiesDetectionJobRequest$InputDataConfig": "

The input properties for a PII entities detection job.

", "StartSentimentDetectionJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", "StartTopicsDetectionJobRequest$InputDataConfig": "

Specifies the format and location of the input data for the job.

", "TopicsDetectionJobProperties$InputDataConfig": "

The input data configuration supplied when you created the topic detection job.

" @@ -861,6 +893,8 @@ "EntityRecognizerMetadataEntityTypesListItem$NumberOfTrainMentions": "

Indicates the number of times the given entity type was seen in the training data.

", "KeyPhrase$BeginOffset": "

A character offset in the input text that shows where the key phrase begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

", "KeyPhrase$EndOffset": "

A character offset in the input text where the key phrase ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

", + "PiiEntity$BeginOffset": "

A character offset in the input text that shows where the PII entity begins (the first character is at position 0). The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

", + "PiiEntity$EndOffset": "

A character offset in the input text that shows where the PII entity ends. The offset returns the position of each UTF-8 code point in the string. A code point is the abstract character from a particular graphical representation. For example, a multi-byte UTF-8 character maps to a single code point.

", "SyntaxToken$TokenId": "

A unique identifier for a token.

", "SyntaxToken$BeginOffset": "

The zero-based offset from the beginning of the source text to the first character in the word.

", "SyntaxToken$EndOffset": "

The zero-based offset from the beginning of the source text to the last character in the word.

", @@ -889,17 +923,20 @@ "DescribeDominantLanguageDetectionJobRequest$JobId": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

", "DescribeEntitiesDetectionJobRequest$JobId": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

", "DescribeKeyPhrasesDetectionJobRequest$JobId": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

", + "DescribePiiEntitiesDetectionJobRequest$JobId": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

", "DescribeSentimentDetectionJobRequest$JobId": "

The identifier that Amazon Comprehend generated for the job. The operation returns this identifier in its response.

", "DescribeTopicsDetectionJobRequest$JobId": "

The identifier assigned by the user to the detection job.

", "DocumentClassificationJobProperties$JobId": "

The identifier assigned to the document classification job.

", "DominantLanguageDetectionJobProperties$JobId": "

The identifier assigned to the dominant language detection job.

", "EntitiesDetectionJobProperties$JobId": "

The identifier assigned to the entities detection job.

", "KeyPhrasesDetectionJobProperties$JobId": "

The identifier assigned to the key phrases detection job.

", + "PiiEntitiesDetectionJobProperties$JobId": "

The identifier assigned to the PII entities detection job.

", "SentimentDetectionJobProperties$JobId": "

The identifier assigned to the sentiment detection job.

", "StartDocumentClassificationJobResponse$JobId": "

The identifier generated for the job. To get the status of the job, use this identifier with the operation.

", "StartDominantLanguageDetectionJobResponse$JobId": "

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

", "StartEntitiesDetectionJobResponse$JobId": "

The identifier generated for the job. To get the status of job, use this identifier with the operation.

", "StartKeyPhrasesDetectionJobResponse$JobId": "

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

", + "StartPiiEntitiesDetectionJobResponse$JobId": "

The identifier generated for the job.

", "StartSentimentDetectionJobResponse$JobId": "

The identifier generated for the job. To get the status of a job, use this identifier with the operation.

", "StartTopicsDetectionJobResponse$JobId": "

The identifier generated for the job. To get the status of the job, use this identifier with the DescribeTopicDetectionJob operation.

", "StopDominantLanguageDetectionJobRequest$JobId": "

The identifier of the dominant language detection job to stop.

", @@ -908,6 +945,8 @@ "StopEntitiesDetectionJobResponse$JobId": "

The identifier of the entities detection job to stop.

", "StopKeyPhrasesDetectionJobRequest$JobId": "

The identifier of the key phrases detection job to stop.

", "StopKeyPhrasesDetectionJobResponse$JobId": "

The identifier of the key phrases detection job to stop.

", + "StopPiiEntitiesDetectionJobRequest$JobId": "

The identifier of the PII entities detection job to stop.

", + "StopPiiEntitiesDetectionJobResponse$JobId": "

The identifier of the PII entities detection job to stop.

", "StopSentimentDetectionJobRequest$JobId": "

The identifier of the sentiment detection job to stop.

", "StopSentimentDetectionJobResponse$JobId": "

The identifier of the sentiment detection job to stop.

", "TopicsDetectionJobProperties$JobId": "

The identifier assigned to the topic detection job.

" @@ -924,12 +963,15 @@ "EntitiesDetectionJobProperties$JobName": "

The name that you assigned the entities detection job.

", "KeyPhrasesDetectionJobFilter$JobName": "

Filters on the name of the job.

", "KeyPhrasesDetectionJobProperties$JobName": "

The name that you assigned the key phrases detection job.

", + "PiiEntitiesDetectionJobFilter$JobName": "

Filters on the name of the job.

", + "PiiEntitiesDetectionJobProperties$JobName": "

The name that you assigned the PII entities detection job.

", "SentimentDetectionJobFilter$JobName": "

Filters on the name of the job.

", "SentimentDetectionJobProperties$JobName": "

The name that you assigned to the sentiment detection job

", "StartDocumentClassificationJobRequest$JobName": "

The identifier of the job.

", "StartDominantLanguageDetectionJobRequest$JobName": "

An identifier for the job.

", "StartEntitiesDetectionJobRequest$JobName": "

The identifier of the job.

", "StartKeyPhrasesDetectionJobRequest$JobName": "

The identifier of the job.

", + "StartPiiEntitiesDetectionJobRequest$JobName": "

The identifier of the job.

", "StartSentimentDetectionJobRequest$JobName": "

The identifier of the job.

", "StartTopicsDetectionJobRequest$JobName": "

The identifier of the job.

", "TopicsDetectionJobFilter$JobName": "

", @@ -952,17 +994,21 @@ "EntitiesDetectionJobProperties$JobStatus": "

The current status of the entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

", "KeyPhrasesDetectionJobFilter$JobStatus": "

Filters the list of jobs based on job status. Returns only jobs with the specified status.

", "KeyPhrasesDetectionJobProperties$JobStatus": "

The current status of the key phrases detection job. If the status is FAILED, the Message field shows the reason for the failure.

", + "PiiEntitiesDetectionJobFilter$JobStatus": "

Filters the list of jobs based on job status. Returns only jobs with the specified status.

", + "PiiEntitiesDetectionJobProperties$JobStatus": "

The current status of the PII entities detection job. If the status is FAILED, the Message field shows the reason for the failure.

", "SentimentDetectionJobFilter$JobStatus": "

Filters the list of jobs based on job status. Returns only jobs with the specified status.

", "SentimentDetectionJobProperties$JobStatus": "

The current status of the sentiment detection job. If the status is FAILED, the Messages field shows the reason for the failure.

", "StartDocumentClassificationJobResponse$JobStatus": "

The status of the job:

", "StartDominantLanguageDetectionJobResponse$JobStatus": "

The status of the job.

", "StartEntitiesDetectionJobResponse$JobStatus": "

The status of the job.

", "StartKeyPhrasesDetectionJobResponse$JobStatus": "

The status of the job.

", + "StartPiiEntitiesDetectionJobResponse$JobStatus": "

The status of the job.

", "StartSentimentDetectionJobResponse$JobStatus": "

The status of the job.

", "StartTopicsDetectionJobResponse$JobStatus": "

The status of the job:

", "StopDominantLanguageDetectionJobResponse$JobStatus": "

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopDominantLanguageDetectionJob operation.

", "StopEntitiesDetectionJobResponse$JobStatus": "

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopEntitiesDetectionJob operation.

", "StopKeyPhrasesDetectionJobResponse$JobStatus": "

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopKeyPhrasesDetectionJob operation.

", + "StopPiiEntitiesDetectionJobResponse$JobStatus": "

The status of the PII entities detection job.

", "StopSentimentDetectionJobResponse$JobStatus": "

Either STOP_REQUESTED if the job is currently running, or STOPPED if the job was previously stopped with the StopSentimentDetectionJob operation.

", "TopicsDetectionJobFilter$JobStatus": "

Filters the list of topic detection jobs based on job status. Returns only jobs with the specified status.

", "TopicsDetectionJobProperties$JobStatus": "

The current status of the topic detection job. If the status is Failed, the reason for the failure is shown in the Message field.

" @@ -1006,6 +1052,7 @@ "EntityRecognizerProperties$VolumeKmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

", "KeyPhrasesDetectionJobProperties$VolumeKmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

", "OutputDataConfig$KmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job. The KmsKeyId can be one of the following formats:

", + "PiiOutputDataConfig$KmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt the output results from an analysis job.

", "SentimentDetectionJobProperties$VolumeKmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

", "StartDocumentClassificationJobRequest$VolumeKmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

", "StartDominantLanguageDetectionJobRequest$VolumeKmsKeyId": "

ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses to encrypt data on the storage volume attached to the ML compute instance(s) that process the analysis job. The VolumeKmsKeyId can be either of the following formats:

", @@ -1037,14 +1084,17 @@ "CreateEntityRecognizerRequest$LanguageCode": "

You can specify any of the following languages supported by Amazon Comprehend: English (\"en\"), Spanish (\"es\"), French (\"fr\"), Italian (\"it\"), German (\"de\"), or Portuguese (\"pt\"). All documents must be in the same language.

", "DetectEntitiesRequest$LanguageCode": "

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

If your request includes the endpoint for a custom entity recognition model, Amazon Comprehend uses the language of your custom model, and it ignores any language code that you specify here.

", "DetectKeyPhrasesRequest$LanguageCode": "

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

", + "DetectPiiEntitiesRequest$LanguageCode": "

The language of the input documents.

", "DetectSentimentRequest$LanguageCode": "

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

", "DocumentClassifierProperties$LanguageCode": "

The language code for the language of the documents that the classifier was trained on.

", "EntitiesDetectionJobProperties$LanguageCode": "

The language code of the input documents.

", "EntityRecognizerProperties$LanguageCode": "

The language of the input documents. All documents must be in the same language. Only English (\"en\") is currently supported.

", "KeyPhrasesDetectionJobProperties$LanguageCode": "

The language code of the input documents.

", + "PiiEntitiesDetectionJobProperties$LanguageCode": "

The language code of the input documents

", "SentimentDetectionJobProperties$LanguageCode": "

The language code of the input documents.

", "StartEntitiesDetectionJobRequest$LanguageCode": "

The language of the input documents. All documents must be in the same language. You can specify any of the languages supported by Amazon Comprehend. If custom entities recognition is used, this parameter is ignored and the language used for training the model is used instead.

", "StartKeyPhrasesDetectionJobRequest$LanguageCode": "

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

", + "StartPiiEntitiesDetectionJobRequest$LanguageCode": "

The language of the input documents.

", "StartSentimentDetectionJobRequest$LanguageCode": "

The language of the input documents. You can specify any of the primary languages supported by Amazon Comprehend. All documents must be in the same language.

" } }, @@ -1181,6 +1231,18 @@ "ClassifyDocumentResponse$Labels": "

The labels used the document being analyzed. These are used for multi-label trained models. Individual labels represent different categories that are related in some manner and are not multually exclusive. For example, a movie can be just an action movie, or it can be an action movie, a science fiction movie, and a comedy, all at the same time.

" } }, + "ListOfPiiEntities": { + "base": null, + "refs": { + "DetectPiiEntitiesResponse$Entities": "

A collection of PII entities identified in the input text. For each entity, the response provides the entity type, where the entity text begins and ends, and the level of confidence that Amazon Comprehend has in the detection.

" + } + }, + "ListOfPiiEntityTypes": { + "base": null, + "refs": { + "RedactionConfig$PiiEntityTypes": "

An array of the types of PII entities that Amazon Comprehend detects in the input text for your request.

" + } + }, "ListOfSyntaxTokens": { "base": null, "refs": { @@ -1188,6 +1250,16 @@ "DetectSyntaxResponse$SyntaxTokens": "

A collection of syntax tokens describing the text. For each token, the response provides the text, the token type, where the text begins and ends, and the level of confidence that Amazon Comprehend has that the token is correct. For a list of token types, see how-syntax.

" } }, + "ListPiiEntitiesDetectionJobsRequest": { + "base": null, + "refs": { + } + }, + "ListPiiEntitiesDetectionJobsResponse": { + "base": null, + "refs": { + } + }, "ListSentimentDetectionJobsRequest": { "base": null, "refs": { @@ -1218,6 +1290,12 @@ "refs": { } }, + "MaskCharacter": { + "base": null, + "refs": { + "RedactionConfig$MaskCharacter": "

A character that replaces each character in the redacted PII entity.

" + } + }, "MaxResultsInteger": { "base": null, "refs": { @@ -1228,6 +1306,7 @@ "ListEntitiesDetectionJobsRequest$MaxResults": "

The maximum number of results to return in each page. The default is 100.

", "ListEntityRecognizersRequest$MaxResults": "

The maximum number of results to return on each page. The default is 100.

", "ListKeyPhrasesDetectionJobsRequest$MaxResults": "

The maximum number of results to return in each page. The default is 100.

", + "ListPiiEntitiesDetectionJobsRequest$MaxResults": "

The maximum number of results to return in each page.

", "ListSentimentDetectionJobsRequest$MaxResults": "

The maximum number of results to return in each page. The default is 100.

", "ListTopicsDetectionJobsRequest$MaxResults": "

The maximum number of results to return in each page. The default is 100.

" } @@ -1259,6 +1338,7 @@ "StartDominantLanguageDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files.

", "StartEntitiesDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files.

", "StartKeyPhrasesDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files.

", + "StartPiiEntitiesDetectionJobRequest$OutputDataConfig": "

Provides configuration parameters for the output of PII entity detection jobs.

", "StartSentimentDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files.

", "StartTopicsDetectionJobRequest$OutputDataConfig": "

Specifies where to send the output files. The output is a compressed archive with two files, topic-terms.csv that lists the terms associated with each topic, and doc-topics.csv that lists the documents associated with each topic

", "TopicsDetectionJobProperties$OutputDataConfig": "

The output data configuration supplied when you created the topic detection job.

" @@ -1276,6 +1356,64 @@ "PartOfSpeechTag$Tag": "

Identifies the part of speech that the token represents.

" } }, + "PiiEntitiesDetectionJobFilter": { + "base": "

Provides information for filtering a list of PII entity detection jobs.

", + "refs": { + "ListPiiEntitiesDetectionJobsRequest$Filter": "

Filters the jobs that are returned. You can filter jobs on their name, status, or the date and time that they were submitted. You can only set one filter at a time.

" + } + }, + "PiiEntitiesDetectionJobProperties": { + "base": "

Provides information about a PII entities detection job.

", + "refs": { + "DescribePiiEntitiesDetectionJobResponse$PiiEntitiesDetectionJobProperties": null, + "PiiEntitiesDetectionJobPropertiesList$member": null + } + }, + "PiiEntitiesDetectionJobPropertiesList": { + "base": null, + "refs": { + "ListPiiEntitiesDetectionJobsResponse$PiiEntitiesDetectionJobPropertiesList": "

A list containing the properties of each job that is returned.

" + } + }, + "PiiEntitiesDetectionMaskMode": { + "base": null, + "refs": { + "RedactionConfig$MaskMode": "

Specifies whether the PII entity is redacted with the mask character or the entity type.

" + } + }, + "PiiEntitiesDetectionMode": { + "base": null, + "refs": { + "PiiEntitiesDetectionJobProperties$Mode": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

", + "StartPiiEntitiesDetectionJobRequest$Mode": "

Specifies whether the output provides the locations (offsets) of PII entities or a file in which PII entities are redacted.

" + } + }, + "PiiEntity": { + "base": "

Provides information about a PII entity.

", + "refs": { + "ListOfPiiEntities$member": null + } + }, + "PiiEntityType": { + "base": null, + "refs": { + "ListOfPiiEntityTypes$member": null, + "PiiEntity$Type": "

The entity's type.

" + } + }, + "PiiOutputDataConfig": { + "base": "

Provides configuration parameters for the output of PII entity detection jobs.

", + "refs": { + "PiiEntitiesDetectionJobProperties$OutputDataConfig": "

The output data configuration that you supplied when you created the PII entities detection job.

" + } + }, + "RedactionConfig": { + "base": "

Provides configuration parameters for PII entity redaction.

", + "refs": { + "PiiEntitiesDetectionJobProperties$RedactionConfig": "

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

", + "StartPiiEntitiesDetectionJobRequest$RedactionConfig": "

Provides configuration parameters for PII entity redaction.

This parameter is required if you set the Mode parameter to ONLY_REDACTION. In that case, you must provide a RedactionConfig definition that includes the PiiEntityTypes parameter.

" + } + }, "ResourceInUseException": { "base": "

The specified resource name is already in use. Use a different name and try your request again.

", "refs": { @@ -1305,7 +1443,8 @@ "EntityRecognizerDocuments$S3Uri": "

Specifies the Amazon S3 location where the training documents for an entity recognizer are located. The URI must be in the same region as the API endpoint that you are calling.

", "EntityRecognizerEntityList$S3Uri": "

Specifies the Amazon S3 location where the entity list is located. The URI must be in the same region as the API endpoint that you are calling.

", "InputDataConfig$S3Uri": "

The Amazon S3 URI for the input data. The URI must be in same region as the API endpoint that you are calling. The URI can point to a single input file or it can provide the prefix for a collection of data files.

For example, if you use the URI S3://bucketName/prefix, if the prefix is a single file, Amazon Comprehend uses that file as input. If more than one file begins with the prefix, Amazon Comprehend uses all of them as input.

", - "OutputDataConfig$S3Uri": "

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

" + "OutputDataConfig$S3Uri": "

When you use the OutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data. The URI must be in the same region as the API endpoint that you are calling. The location is used as the prefix for the actual location of the output file.

When the topic detection job is finished, the service creates an output file in a directory specific to the job. The S3Uri field contains the location of the output file, called output.tar.gz. It is a compressed archive that contains the ouput of the operation.

", + "PiiOutputDataConfig$S3Uri": "

When you use the PiiOutputDataConfig object with asynchronous operations, you specify the Amazon S3 location where you want to write the output data.

" } }, "SecurityGroupId": { @@ -1393,6 +1532,16 @@ "refs": { } }, + "StartPiiEntitiesDetectionJobRequest": { + "base": null, + "refs": { + } + }, + "StartPiiEntitiesDetectionJobResponse": { + "base": null, + "refs": { + } + }, "StartSentimentDetectionJobRequest": { "base": null, "refs": { @@ -1443,6 +1592,16 @@ "refs": { } }, + "StopPiiEntitiesDetectionJobRequest": { + "base": null, + "refs": { + } + }, + "StopPiiEntitiesDetectionJobResponse": { + "base": null, + "refs": { + } + }, "StopSentimentDetectionJobRequest": { "base": null, "refs": { @@ -1480,6 +1639,7 @@ "BatchItemError$ErrorMessage": "

A text description of the error.

", "BatchSizeLimitExceededException$Message": null, "ConcurrentModificationException$Message": null, + "DetectPiiEntitiesRequest$Text": "

A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 encoded characters.

", "DocumentClass$Name": "

The name of the class.

", "DocumentLabel$Name": "

The name of the label.

", "DominantLanguage$LanguageCode": "

The RFC 5646 language code for the dominant language. For more information about RFC 5646, see Tags for Identifying Languages on the IETF Tools web site.

", @@ -1504,6 +1664,8 @@ "ListEntityRecognizersResponse$NextToken": "

Identifies the next page of results to return.

", "ListKeyPhrasesDetectionJobsRequest$NextToken": "

Identifies the next page of results to return.

", "ListKeyPhrasesDetectionJobsResponse$NextToken": "

Identifies the next page of results to return.

", + "ListPiiEntitiesDetectionJobsRequest$NextToken": "

Identifies the next page of results to return.

", + "ListPiiEntitiesDetectionJobsResponse$NextToken": "

Identifies the next page of results to return.

", "ListSentimentDetectionJobsRequest$NextToken": "

Identifies the next page of results to return.

", "ListSentimentDetectionJobsResponse$NextToken": "

Identifies the next page of results to return.

", "ListTopicsDetectionJobsRequest$NextToken": "

Identifies the next page of results to return.

", @@ -1630,6 +1792,10 @@ "KeyPhrasesDetectionJobFilter$SubmitTimeAfter": "

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

", "KeyPhrasesDetectionJobProperties$SubmitTime": "

The time that the key phrases detection job was submitted for processing.

", "KeyPhrasesDetectionJobProperties$EndTime": "

The time that the key phrases detection job completed.

", + "PiiEntitiesDetectionJobFilter$SubmitTimeBefore": "

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

", + "PiiEntitiesDetectionJobFilter$SubmitTimeAfter": "

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

", + "PiiEntitiesDetectionJobProperties$SubmitTime": "

The time that the PII entities detection job was submitted for processing.

", + "PiiEntitiesDetectionJobProperties$EndTime": "

The time that the PII entities detection job completed.

", "SentimentDetectionJobFilter$SubmitTimeBefore": "

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted before the specified time. Jobs are returned in ascending order, oldest to newest.

", "SentimentDetectionJobFilter$SubmitTimeAfter": "

Filters the list of jobs based on the time that the job was submitted for processing. Returns only jobs submitted after the specified time. Jobs are returned in descending order, newest to oldest.

", "SentimentDetectionJobProperties$SubmitTime": "

The time that the sentiment detection job was submitted for processing.

", diff --git a/models/apis/es/2015-01-01/api-2.json b/models/apis/es/2015-01-01/api-2.json index 44711911ce..a418911f4a 100644 --- a/models/apis/es/2015-01-01/api-2.json +++ b/models/apis/es/2015-01-01/api-2.json @@ -1805,7 +1805,8 @@ "enum":[ "INDEX_SLOW_LOGS", "SEARCH_SLOW_LOGS", - "ES_APPLICATION_LOGS" + "ES_APPLICATION_LOGS", + "AUDIT_LOGS" ] }, "MasterUserOptions":{ diff --git a/models/apis/es/2015-01-01/docs-2.json b/models/apis/es/2015-01-01/docs-2.json index d1c51ebe17..30a412d0a1 100644 --- a/models/apis/es/2015-01-01/docs-2.json +++ b/models/apis/es/2015-01-01/docs-2.json @@ -1002,7 +1002,7 @@ } }, "LogType": { - "base": "

Type of Log File, it can be one of the following:

", + "base": "

Type of Log File, it can be one of the following:

", "refs": { "LogPublishingOptions$key": null } diff --git a/models/apis/kendra/2019-02-03/api-2.json b/models/apis/kendra/2019-02-03/api-2.json index e6b2be6734..a259d8d37a 100644 --- a/models/apis/kendra/2019-02-03/api-2.json +++ b/models/apis/kendra/2019-02-03/api-2.json @@ -680,7 +680,8 @@ "Description":{"shape":"Description"}, "S3Path":{"shape":"S3Path"}, "RoleArn":{"shape":"RoleArn"}, - "Tags":{"shape":"TagList"} + "Tags":{"shape":"TagList"}, + "FileFormat":{"shape":"FaqFileFormat"} } }, "CreateFaqResponse":{ @@ -1002,7 +1003,8 @@ "S3Path":{"shape":"S3Path"}, "Status":{"shape":"FaqStatus"}, "RoleArn":{"shape":"RoleArn"}, - "ErrorMessage":{"shape":"ErrorMessage"} + "ErrorMessage":{"shape":"ErrorMessage"}, + "FileFormat":{"shape":"FaqFileFormat"} } }, "DescribeIndexRequest":{ @@ -1203,6 +1205,14 @@ "type":"list", "member":{"shape":"FacetResult"} }, + "FaqFileFormat":{ + "type":"string", + "enum":[ + "CSV", + "CSV_WITH_HEADER", + "JSON" + ] + }, "FaqId":{ "type":"string", "max":100, @@ -1239,7 +1249,8 @@ "Name":{"shape":"FaqName"}, "Status":{"shape":"FaqStatus"}, "CreatedAt":{"shape":"Timestamp"}, - "UpdatedAt":{"shape":"Timestamp"} + "UpdatedAt":{"shape":"Timestamp"}, + "FileFormat":{"shape":"FaqFileFormat"} } }, "FaqSummaryItems":{ diff --git a/models/apis/kendra/2019-02-03/docs-2.json b/models/apis/kendra/2019-02-03/docs-2.json index b3436cbb45..2a88741ada 100644 --- a/models/apis/kendra/2019-02-03/docs-2.json +++ b/models/apis/kendra/2019-02-03/docs-2.json @@ -4,7 +4,7 @@ "operations": { "BatchDeleteDocument": "

Removes one or more documents from an index. The documents must have been added with the BatchPutDocument operation.

The documents are deleted asynchronously. You can see the progress of the deletion by using AWS CloudWatch. Any error messages releated to the processing of the batch are sent to you CloudWatch log.

", "BatchPutDocument": "

Adds one or more documents to an index.

The BatchPutDocument operation enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this operation to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using AWS CloudWatch. Any error messages related to processing the batch are sent to your AWS CloudWatch log.

", - "CreateDataSource": "

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, connector type and description for your data source. You can choose between an S3 connector, a SharePoint Online connector, and a database connector.

You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", + "CreateDataSource": "

Creates a data source that you use to with an Amazon Kendra index.

You specify a name, data source connector type and description for your data source. You also specify configuration information such as document metadata (author, source URI, and so on) and user context information.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

", "CreateFaq": "

Creates an new set of frequently asked question (FAQ) questions and answers.

", "CreateIndex": "

Creates a new Amazon Kendra index. Index creation is an asynchronous operation. To determine if index creation has completed, check the Status field returned from a call to . The Status field is set to ACTIVE when the index is ready to use.

Once the index is active you can index your documents using the operation or using one of the supported data sources.

", "DeleteDataSource": "

Deletes an Amazon Kendra data source. An exception is not thrown if the data source is already being deleted. While the data source is being deleted, the Status field returned by a call to the operation is set to DELETING. For more information, see Deleting Data Sources.

", @@ -254,7 +254,7 @@ "DataSourceConfiguration": { "base": "

Configuration information for a Amazon Kendra data source.

", "refs": { - "CreateDataSourceRequest$Configuration": "

The connector configuration information that is required to access the repository.

", + "CreateDataSourceRequest$Configuration": "

The data source connector configuration information that is required to access the repository.

", "DescribeDataSourceResponse$Configuration": "

Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.

", "UpdateDataSourceRequest$Configuration": null } @@ -376,9 +376,9 @@ } }, "DataSourceSyncJobMetrics": { - "base": "

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a connector.

", + "base": "

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

", "refs": { - "DataSourceSyncJob$Metrics": "

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a connector.

" + "DataSourceSyncJob$Metrics": "

Maps a batch delete document request to a specific data source sync job. This is optional and should only be supplied when documents are deleted by a data source connector.

" } }, "DataSourceSyncJobStatus": { @@ -427,7 +427,7 @@ "DatabaseConfiguration": { "base": "

Provides the information necessary to connect a database to an index.

", "refs": { - "DataSourceConfiguration$DatabaseConfiguration": "

Provides information necessary to create a connector for a database.

" + "DataSourceConfiguration$DatabaseConfiguration": "

Provides information necessary to create a data source connector for a database.

" } }, "DatabaseEngineType": { @@ -704,6 +704,14 @@ "QueryResult$FacetResults": "

Contains the facet results. A FacetResult contains the counts for each attribute key that was specified in the Facets input parameter.

" } }, + "FaqFileFormat": { + "base": null, + "refs": { + "CreateFaqRequest$FileFormat": "

The format of the input file. You can choose between a basic CSV format, a CSV format that includes customs attributes in a header, and a JSON format that includes custom attributes.

The format must match the format of the file stored in the S3 bucket identified in the S3Path parameter.

For more information, see Adding questions and answers.

", + "DescribeFaqResponse$FileFormat": "

The file format used by the input files for the FAQ.

", + "FaqSummary$FileFormat": "

The file type used to create the FAQ.

" + } + }, "FaqId": { "base": null, "refs": { @@ -1176,7 +1184,7 @@ "S3DataSourceConfiguration": { "base": "

Provides configuration information for a data source to index documents in an Amazon S3 bucket.

", "refs": { - "DataSourceConfiguration$S3Configuration": "

Provides information to create a connector for a document repository in an Amazon S3 bucket.

" + "DataSourceConfiguration$S3Configuration": "

Provides information to create a data source connector for a document repository in an Amazon S3 bucket.

" } }, "S3ObjectKey": { @@ -1373,7 +1381,7 @@ "SharePointConfiguration": { "base": "

Provides configuration information for connecting to a Microsoft SharePoint data source.

", "refs": { - "DataSourceConfiguration$SharePointConfiguration": "

Provides information necessary to create a connector for a Microsoft SharePoint site.

" + "DataSourceConfiguration$SharePointConfiguration": "

Provides information necessary to create a data source connector for a Microsoft SharePoint site.

" } }, "SharePointUrlList": { diff --git a/models/apis/transcribe-streaming/2017-10-26/api-2.json b/models/apis/transcribe-streaming/2017-10-26/api-2.json index 3dcb1c1266..deb0876d04 100755 --- a/models/apis/transcribe-streaming/2017-10-26/api-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/api-2.json @@ -136,6 +136,10 @@ "max":48000, "min":8000 }, + "NumberOfChannels":{ + "type":"integer", + "min":2 + }, "RequestId":{"type":"string"}, "Result":{ "type":"structure", @@ -144,7 +148,8 @@ "StartTime":{"shape":"Double"}, "EndTime":{"shape":"Double"}, "IsPartial":{"shape":"Boolean"}, - "Alternatives":{"shape":"AlternativeList"} + "Alternatives":{"shape":"AlternativeList"}, + "ChannelId":{"shape":"String"} } }, "ResultList":{ @@ -161,6 +166,8 @@ }, "SessionId":{ "type":"string", + "max":36, + "min":36, "pattern":"[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{4}-[a-fA-F0-9]{12}" }, "StartStreamTranscriptionRequest":{ @@ -212,6 +219,16 @@ "shape":"Boolean", "location":"header", "locationName":"x-amzn-transcribe-show-speaker-label" + }, + "EnableChannelIdentification":{ + "shape":"Boolean", + "location":"header", + "locationName":"x-amzn-transcribe-enable-channel-identification" + }, + "NumberOfChannels":{ + "shape":"NumberOfChannels", + "location":"header", + "locationName":"x-amzn-transcribe-number-of-channels" } }, "payload":"AudioStream" @@ -264,6 +281,16 @@ "shape":"Boolean", "location":"header", "locationName":"x-amzn-transcribe-show-speaker-label" + }, + "EnableChannelIdentification":{ + "shape":"Boolean", + "location":"header", + "locationName":"x-amzn-transcribe-enable-channel-identification" + }, + "NumberOfChannels":{ + "shape":"NumberOfChannels", + "location":"header", + "locationName":"x-amzn-transcribe-number-of-channels" } }, "payload":"TranscriptResultStream" diff --git a/models/apis/transcribe-streaming/2017-10-26/docs-2.json b/models/apis/transcribe-streaming/2017-10-26/docs-2.json index 26c1716151..572ae607d4 100755 --- a/models/apis/transcribe-streaming/2017-10-26/docs-2.json +++ b/models/apis/transcribe-streaming/2017-10-26/docs-2.json @@ -47,7 +47,9 @@ "Item$VocabularyFilterMatch": "

Indicates whether a word in the item matches a word in the vocabulary filter you've chosen for your real-time stream. If true then a word in the item matches your vocabulary filter.

", "Result$IsPartial": "

Amazon Transcribe divides the incoming audio stream into segments at natural points in the audio. Transcription results are returned based on these segments.

The IsPartial field is true to indicate that Amazon Transcribe has additional transcription data to send, false to indicate that this is the last transcription result for the segment.

", "StartStreamTranscriptionRequest$ShowSpeakerLabel": "

When true, enables speaker identification in your real-time stream.

", - "StartStreamTranscriptionResponse$ShowSpeakerLabel": "

Shows whether speaker identification was enabled in the stream.

" + "StartStreamTranscriptionRequest$EnableChannelIdentification": "

When true, instructs Amazon Transcribe to process each audio channel separately and then merge the transcription output of each channel into a single transcription.

Amazon Transcribe also produces a transcription of each item. An item includes the start time, end time, and any alternative transcriptions.

You can't set both ShowSpeakerLabel and EnableChannelIdentification in the same request. If you set both, your request returns a BadRequestException.

", + "StartStreamTranscriptionResponse$ShowSpeakerLabel": "

Shows whether speaker identification was enabled in the stream.

", + "StartStreamTranscriptionResponse$EnableChannelIdentification": "

Shows whether channel identification has been enabled in the stream.

" } }, "ConflictException": { @@ -116,6 +118,13 @@ "StartStreamTranscriptionResponse$MediaSampleRateHertz": "

The sample rate for the input audio stream. Use 8000 Hz for low quality audio and 16000 Hz for high quality audio.

" } }, + "NumberOfChannels": { + "base": null, + "refs": { + "StartStreamTranscriptionRequest$NumberOfChannels": "

The number of channels that are in your audio stream.

", + "StartStreamTranscriptionResponse$NumberOfChannels": "

The number of channels identified in the stream.

" + } + }, "RequestId": { "base": null, "refs": { @@ -168,6 +177,7 @@ "Item$Speaker": "

If speaker identification is enabled, shows the speakers identified in the real-time stream.

", "LimitExceededException$Message": null, "Result$ResultId": "

A unique identifier for the result.

", + "Result$ChannelId": "

When channel identification is enabled, Amazon Transcribe transcribes the speech from each audio channel separately.

You can use ChannelId to retrieve the transcription results for a single channel in your audio stream.

", "ServiceUnavailableException$Message": null } }, diff --git a/models/endpoints/endpoints.json b/models/endpoints/endpoints.json index 3aa2824690..23918d71ba 100644 --- a/models/endpoints/endpoints.json +++ b/models/endpoints/endpoints.json @@ -247,6 +247,7 @@ "protocols" : [ "https" ] }, "endpoints" : { + "af-south-1" : { }, "ap-east-1" : { }, "ap-northeast-1" : { }, "ap-northeast-2" : { }, @@ -256,6 +257,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, @@ -1125,6 +1127,7 @@ "ca-central-1" : { }, "eu-central-1" : { }, "eu-north-1" : { }, + "eu-south-1" : { }, "eu-west-1" : { }, "eu-west-2" : { }, "eu-west-3" : { }, diff --git a/service/apigateway/api.go b/service/apigateway/api.go index 835db5e32e..a842a6c797 100644 --- a/service/apigateway/api.go +++ b/service/apigateway/api.go @@ -4624,6 +4624,9 @@ func (c *APIGateway) GetDeploymentsRequest(input *GetDeploymentsInput) (req *req // The submitted request is not valid, for example, the input is incomplete // or incorrect. See the accompanying error message for details. // +// * NotFoundException +// The requested resource is not found. Make sure that the request URI is correct. +// // * UnauthorizedException // The request is denied because the caller has insufficient permissions. // @@ -12716,6 +12719,11 @@ type CreateDomainNameInput struct { // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // custom domain name. + MutualTlsAuthentication *MutualTlsAuthenticationInput `locationName:"mutualTlsAuthentication" type:"structure"` + // The reference to an AWS-managed certificate that will be used by regional // endpoint for this domain name. AWS Certificate Manager is the only supported // source. @@ -12800,6 +12808,12 @@ func (s *CreateDomainNameInput) SetEndpointConfiguration(v *EndpointConfiguratio return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *CreateDomainNameInput) SetMutualTlsAuthentication(v *MutualTlsAuthenticationInput) *CreateDomainNameInput { + s.MutualTlsAuthentication = v + return s +} + // SetRegionalCertificateArn sets the RegionalCertificateArn field's value. func (s *CreateDomainNameInput) SetRegionalCertificateArn(v string) *CreateDomainNameInput { s.RegionalCertificateArn = &v @@ -15536,6 +15550,12 @@ type DomainName struct { // of the domain name. EndpointConfiguration *EndpointConfiguration `locationName:"endpointConfiguration" type:"structure"` + // The mutual TLS authentication configuration for a custom domain name. If + // specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthentication `locationName:"mutualTlsAuthentication" type:"structure"` + // The reference to an AWS-managed certificate that will be used for validating // the regional domain name. AWS Certificate Manager is the only supported source. RegionalCertificateArn *string `locationName:"regionalCertificateArn" type:"string"` @@ -15627,6 +15647,12 @@ func (s *DomainName) SetEndpointConfiguration(v *EndpointConfiguration) *DomainN return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *DomainName) SetMutualTlsAuthentication(v *MutualTlsAuthentication) *DomainName { + s.MutualTlsAuthentication = v + return s +} + // SetRegionalCertificateArn sets the RegionalCertificateArn field's value. func (s *DomainName) SetRegionalCertificateArn(v string) *DomainName { s.RegionalCertificateArn = &v @@ -20942,6 +20968,100 @@ func (s *Model) SetSchema(v string) *Model { return s } +// If specified, API Gateway performs two-way authentication between the client +// and the server. Clients must present a trusted certificate to access your +// custom domain name. +type MutualTlsAuthentication struct { + _ struct{} `type:"structure"` + + // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, + // for example s3://bucket-name/key-name. The truststore can contain certificates + // from public or private certificate authorities. To update the truststore, + // upload a new version to S3, and then update your custom domain name to use + // the new version. To update the truststore, you must have permissions to access + // the S3 object. + TruststoreUri *string `locationName:"truststoreUri" type:"string"` + + // The version of the S3 object that contains your truststore. To specify a + // version, you must have versioning enabled for the S3 bucket. + TruststoreVersion *string `locationName:"truststoreVersion" type:"string"` + + // A list of warnings that API Gateway returns while processing your truststore. + // Invalid certificates produce warnings. Mutual TLS is still enabled, but some + // clients might not be able to access your API. To resolve warnings, upload + // a new truststore to S3, and then update you domain name to use the new version. + TruststoreWarnings []*string `locationName:"truststoreWarnings" type:"list"` +} + +// String returns the string representation +func (s MutualTlsAuthentication) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MutualTlsAuthentication) GoString() string { + return s.String() +} + +// SetTruststoreUri sets the TruststoreUri field's value. +func (s *MutualTlsAuthentication) SetTruststoreUri(v string) *MutualTlsAuthentication { + s.TruststoreUri = &v + return s +} + +// SetTruststoreVersion sets the TruststoreVersion field's value. +func (s *MutualTlsAuthentication) SetTruststoreVersion(v string) *MutualTlsAuthentication { + s.TruststoreVersion = &v + return s +} + +// SetTruststoreWarnings sets the TruststoreWarnings field's value. +func (s *MutualTlsAuthentication) SetTruststoreWarnings(v []*string) *MutualTlsAuthentication { + s.TruststoreWarnings = v + return s +} + +// If specified, API Gateway performs two-way authentication between the client +// and the server. Clients must present a trusted certificate to access your +// custom domain name. +type MutualTlsAuthenticationInput struct { + _ struct{} `type:"structure"` + + // An Amazon S3 resource ARN that specifies the truststore for mutual TLS authentication, + // for example, s3://bucket-name/key-name. The truststore can contain certificates + // from public or private certificate authorities. To update the truststore, + // upload a new version to S3, and then update your custom domain name to use + // the new version. To update the truststore, you must have permissions to access + // the S3 object. + TruststoreUri *string `locationName:"truststoreUri" type:"string"` + + // The version of the S3 object that contains your truststore. To specify a + // version, you must have versioning enabled for the S3 bucket. + TruststoreVersion *string `locationName:"truststoreVersion" type:"string"` +} + +// String returns the string representation +func (s MutualTlsAuthenticationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MutualTlsAuthenticationInput) GoString() string { + return s.String() +} + +// SetTruststoreUri sets the TruststoreUri field's value. +func (s *MutualTlsAuthenticationInput) SetTruststoreUri(v string) *MutualTlsAuthenticationInput { + s.TruststoreUri = &v + return s +} + +// SetTruststoreVersion sets the TruststoreVersion field's value. +func (s *MutualTlsAuthenticationInput) SetTruststoreVersion(v string) *MutualTlsAuthenticationInput { + s.TruststoreVersion = &v + return s +} + // The requested resource is not found. Make sure that the request URI is correct. type NotFoundException struct { _ struct{} `type:"structure"` diff --git a/service/apigatewayv2/api.go b/service/apigatewayv2/api.go index cc6e5dbccc..d86d09fd33 100644 --- a/service/apigatewayv2/api.go +++ b/service/apigatewayv2/api.go @@ -6434,6 +6434,12 @@ type Api struct { // The description of the API. Description *string `locationName:"description" type:"string"` + // Specifies whether clients can invoke your API by using the default execute-api + // endpoint. By default, clients can invoke your API with the default https://{api_id}.execute-api.{region}.amazonaws.com + // endpoint. To require that clients use a custom domain name to invoke your + // API, disable the default endpoint. + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + // Avoid validating models when creating a deployment. Supported only for WebSocket // APIs. DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` @@ -6523,6 +6529,12 @@ func (s *Api) SetDescription(v string) *Api { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *Api) SetDisableExecuteApiEndpoint(v bool) *Api { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *Api) SetDisableSchemaValidation(v bool) *Api { s.DisableSchemaValidation = &v @@ -7006,6 +7018,8 @@ type CreateApiInput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` // A string with a length between [1-128]. @@ -7095,6 +7109,12 @@ func (s *CreateApiInput) SetDescription(v string) *CreateApiInput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *CreateApiInput) SetDisableExecuteApiEndpoint(v bool) *CreateApiInput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *CreateApiInput) SetDisableSchemaValidation(v bool) *CreateApiInput { s.DisableSchemaValidation = &v @@ -7302,6 +7322,8 @@ type CreateApiOutput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` ImportInfo []*string `locationName:"importInfo" type:"list"` @@ -7378,6 +7400,12 @@ func (s *CreateApiOutput) SetDescription(v string) *CreateApiOutput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *CreateApiOutput) SetDisableExecuteApiEndpoint(v bool) *CreateApiOutput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *CreateApiOutput) SetDisableSchemaValidation(v bool) *CreateApiOutput { s.DisableSchemaValidation = &v @@ -7844,6 +7872,11 @@ type CreateDomainNameInput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthenticationInput `locationName:"mutualTlsAuthentication" type:"structure"` + // Represents a collection of tags associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7883,6 +7916,12 @@ func (s *CreateDomainNameInput) SetDomainNameConfigurations(v []*DomainNameConfi return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *CreateDomainNameInput) SetMutualTlsAuthentication(v *MutualTlsAuthenticationInput) *CreateDomainNameInput { + s.MutualTlsAuthentication = v + return s +} + // SetTags sets the Tags field's value. func (s *CreateDomainNameInput) SetTags(v map[string]*string) *CreateDomainNameInput { s.Tags = v @@ -7903,6 +7942,11 @@ type CreateDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthentication `locationName:"mutualTlsAuthentication" type:"structure"` + // Represents a collection of tags associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -7935,6 +7979,12 @@ func (s *CreateDomainNameOutput) SetDomainNameConfigurations(v []*DomainNameConf return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *CreateDomainNameOutput) SetMutualTlsAuthentication(v *MutualTlsAuthentication) *CreateDomainNameOutput { + s.MutualTlsAuthentication = v + return s +} + // SetTags sets the Tags field's value. func (s *CreateDomainNameOutput) SetTags(v map[string]*string) *CreateDomainNameOutput { s.Tags = v @@ -10782,6 +10832,9 @@ type DomainName struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + // The mutual TLS authentication configuration for a custom domain name. + MutualTlsAuthentication *MutualTlsAuthentication `locationName:"mutualTlsAuthentication" type:"structure"` + // The collection of tags associated with a domain name. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -10814,6 +10867,12 @@ func (s *DomainName) SetDomainNameConfigurations(v []*DomainNameConfiguration) * return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *DomainName) SetMutualTlsAuthentication(v *MutualTlsAuthentication) *DomainName { + s.MutualTlsAuthentication = v + return s +} + // SetTags sets the Tags field's value. func (s *DomainName) SetTags(v map[string]*string) *DomainName { s.Tags = v @@ -11298,6 +11357,8 @@ type GetApiOutput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` ImportInfo []*string `locationName:"importInfo" type:"list"` @@ -11374,6 +11435,12 @@ func (s *GetApiOutput) SetDescription(v string) *GetApiOutput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *GetApiOutput) SetDisableExecuteApiEndpoint(v bool) *GetApiOutput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *GetApiOutput) SetDisableSchemaValidation(v bool) *GetApiOutput { s.DisableSchemaValidation = &v @@ -12011,6 +12078,11 @@ type GetDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthentication `locationName:"mutualTlsAuthentication" type:"structure"` + // Represents a collection of tags associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -12043,6 +12115,12 @@ func (s *GetDomainNameOutput) SetDomainNameConfigurations(v []*DomainNameConfigu return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *GetDomainNameOutput) SetMutualTlsAuthentication(v *MutualTlsAuthentication) *GetDomainNameOutput { + s.MutualTlsAuthentication = v + return s +} + // SetTags sets the Tags field's value. func (s *GetDomainNameOutput) SetTags(v map[string]*string) *GetDomainNameOutput { s.Tags = v @@ -14122,6 +14200,8 @@ type ImportApiOutput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` ImportInfo []*string `locationName:"importInfo" type:"list"` @@ -14198,6 +14278,12 @@ func (s *ImportApiOutput) SetDescription(v string) *ImportApiOutput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *ImportApiOutput) SetDisableExecuteApiEndpoint(v bool) *ImportApiOutput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *ImportApiOutput) SetDisableSchemaValidation(v bool) *ImportApiOutput { s.DisableSchemaValidation = &v @@ -14719,6 +14805,100 @@ func (s *Model) SetSchema(v string) *Model { return s } +// If specified, API Gateway performs two-way authentication between the client +// and the server. Clients must present a trusted certificate to access your +// API. +type MutualTlsAuthentication struct { + _ struct{} `type:"structure"` + + // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, + // for example, s3://bucket-name/key-name. The truststore can contain certificates + // from public or private certificate authorities. To update the truststore, + // upload a new version to S3, and then update your custom domain name to use + // the new version. To update the truststore, you must have permissions to access + // the S3 object. + TruststoreUri *string `locationName:"truststoreUri" type:"string"` + + // The version of the S3 object that contains your truststore. To specify a + // version, you must have versioning enabled for the S3 bucket. + TruststoreVersion *string `locationName:"truststoreVersion" type:"string"` + + // A list of warnings that API Gateway returns while processing your truststore. + // Invalid certificates produce warnings. Mutual TLS is still enabled, but some + // clients might not be able to access your API. To resolve warnings, upload + // a new truststore to S3, and then update you domain name to use the new version. + TruststoreWarnings []*string `locationName:"truststoreWarnings" type:"list"` +} + +// String returns the string representation +func (s MutualTlsAuthentication) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MutualTlsAuthentication) GoString() string { + return s.String() +} + +// SetTruststoreUri sets the TruststoreUri field's value. +func (s *MutualTlsAuthentication) SetTruststoreUri(v string) *MutualTlsAuthentication { + s.TruststoreUri = &v + return s +} + +// SetTruststoreVersion sets the TruststoreVersion field's value. +func (s *MutualTlsAuthentication) SetTruststoreVersion(v string) *MutualTlsAuthentication { + s.TruststoreVersion = &v + return s +} + +// SetTruststoreWarnings sets the TruststoreWarnings field's value. +func (s *MutualTlsAuthentication) SetTruststoreWarnings(v []*string) *MutualTlsAuthentication { + s.TruststoreWarnings = v + return s +} + +// If specified, API Gateway performs two-way authentication between the client +// and the server. Clients must present a trusted certificate to access your +// API. +type MutualTlsAuthenticationInput struct { + _ struct{} `type:"structure"` + + // An Amazon S3 URL that specifies the truststore for mutual TLS authentication, + // for example, s3://bucket-name/key-name. The truststore can contain certificates + // from public or private certificate authorities. To update the truststore, + // upload a new version to S3, and then update your custom domain name to use + // the new version. To update the truststore, you must have permissions to access + // the S3 object. + TruststoreUri *string `locationName:"truststoreUri" type:"string"` + + // The version of the S3 object that contains your truststore. To specify a + // version, you must have versioning enabled for the S3 bucket. + TruststoreVersion *string `locationName:"truststoreVersion" type:"string"` +} + +// String returns the string representation +func (s MutualTlsAuthenticationInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s MutualTlsAuthenticationInput) GoString() string { + return s.String() +} + +// SetTruststoreUri sets the TruststoreUri field's value. +func (s *MutualTlsAuthenticationInput) SetTruststoreUri(v string) *MutualTlsAuthenticationInput { + s.TruststoreUri = &v + return s +} + +// SetTruststoreVersion sets the TruststoreVersion field's value. +func (s *MutualTlsAuthenticationInput) SetTruststoreVersion(v string) *MutualTlsAuthenticationInput { + s.TruststoreVersion = &v + return s +} + // The resource specified in the request was not found. See the message field // for more information. type NotFoundException struct { @@ -14897,6 +15077,8 @@ type ReimportApiOutput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` ImportInfo []*string `locationName:"importInfo" type:"list"` @@ -14973,6 +15155,12 @@ func (s *ReimportApiOutput) SetDescription(v string) *ReimportApiOutput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *ReimportApiOutput) SetDisableExecuteApiEndpoint(v bool) *ReimportApiOutput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *ReimportApiOutput) SetDisableSchemaValidation(v bool) *ReimportApiOutput { s.DisableSchemaValidation = &v @@ -15781,6 +15969,8 @@ type UpdateApiInput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` // A string with a length between [1-128]. @@ -15866,6 +16056,12 @@ func (s *UpdateApiInput) SetDescription(v string) *UpdateApiInput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *UpdateApiInput) SetDisableExecuteApiEndpoint(v bool) *UpdateApiInput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *UpdateApiInput) SetDisableSchemaValidation(v bool) *UpdateApiInput { s.DisableSchemaValidation = &v @@ -16071,6 +16267,8 @@ type UpdateApiOutput struct { // A string with a length between [0-1024]. Description *string `locationName:"description" type:"string"` + DisableExecuteApiEndpoint *bool `locationName:"disableExecuteApiEndpoint" type:"boolean"` + DisableSchemaValidation *bool `locationName:"disableSchemaValidation" type:"boolean"` ImportInfo []*string `locationName:"importInfo" type:"list"` @@ -16147,6 +16345,12 @@ func (s *UpdateApiOutput) SetDescription(v string) *UpdateApiOutput { return s } +// SetDisableExecuteApiEndpoint sets the DisableExecuteApiEndpoint field's value. +func (s *UpdateApiOutput) SetDisableExecuteApiEndpoint(v bool) *UpdateApiOutput { + s.DisableExecuteApiEndpoint = &v + return s +} + // SetDisableSchemaValidation sets the DisableSchemaValidation field's value. func (s *UpdateApiOutput) SetDisableSchemaValidation(v bool) *UpdateApiOutput { s.DisableSchemaValidation = &v @@ -16616,6 +16820,11 @@ type UpdateDomainNameInput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthenticationInput `locationName:"mutualTlsAuthentication" type:"structure"` } // String returns the string representation @@ -16656,6 +16865,12 @@ func (s *UpdateDomainNameInput) SetDomainNameConfigurations(v []*DomainNameConfi return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *UpdateDomainNameInput) SetMutualTlsAuthentication(v *MutualTlsAuthenticationInput) *UpdateDomainNameInput { + s.MutualTlsAuthentication = v + return s +} + type UpdateDomainNameOutput struct { _ struct{} `type:"structure"` @@ -16670,6 +16885,11 @@ type UpdateDomainNameOutput struct { // The domain name configurations. DomainNameConfigurations []*DomainNameConfiguration `locationName:"domainNameConfigurations" type:"list"` + // If specified, API Gateway performs two-way authentication between the client + // and the server. Clients must present a trusted certificate to access your + // API. + MutualTlsAuthentication *MutualTlsAuthentication `locationName:"mutualTlsAuthentication" type:"structure"` + // Represents a collection of tags associated with the resource. Tags map[string]*string `locationName:"tags" type:"map"` } @@ -16702,6 +16922,12 @@ func (s *UpdateDomainNameOutput) SetDomainNameConfigurations(v []*DomainNameConf return s } +// SetMutualTlsAuthentication sets the MutualTlsAuthentication field's value. +func (s *UpdateDomainNameOutput) SetMutualTlsAuthentication(v *MutualTlsAuthentication) *UpdateDomainNameOutput { + s.MutualTlsAuthentication = v + return s +} + // SetTags sets the Tags field's value. func (s *UpdateDomainNameOutput) SetTags(v map[string]*string) *UpdateDomainNameOutput { s.Tags = v diff --git a/service/cloudfront/api.go b/service/cloudfront/api.go index 29794d394b..699a3c813c 100644 --- a/service/cloudfront/api.go +++ b/service/cloudfront/api.go @@ -11644,8 +11644,6 @@ type DistributionConfig struct { // in the Amazon CloudFront Developer Guide. For information about CloudFront // pricing, including how price classes (such as Price Class 100) map to CloudFront // regions, see Amazon CloudFront Pricing (http://aws.amazon.com/cloudfront/pricing/). - // For price class information, scroll down to see the table at the bottom of - // the page. PriceClass *string `type:"string" enum:"PriceClass"` // A complex type that identifies ways in which you want to restrict distribution @@ -17964,15 +17962,18 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // // * Includes the normalized header in the cache key // - // * Includes the normalized header in the request to the origin - // - // If one or both of these fields are true, you should not whitelist the Accept-Encoding - // header in the cache policy or in an origin request policy attached to the - // same cache behavior. + // * Includes the normalized header in the request to the origin, if a request + // is necessary // // For more information, see Cache compressed objects (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) // in the Amazon CloudFront Developer Guide. // + // If you set this value to true, and this cache behavior also has an origin + // request policy attached, do not include the Accept-Encoding header in the + // origin request policy. CloudFront always includes the Accept-Encoding header + // in origin requests when the value of this field is true, so including this + // header in an origin request policy has no effect. + // // If both of these fields are false, then CloudFront treats the Accept-Encoding // header the same as any other HTTP header in the viewer request. By default, // it’s not included in the cache key and it’s not included in origin requests. @@ -17991,15 +17992,18 @@ type ParametersInCacheKeyAndForwardedToOrigin struct { // // * Includes the normalized header in the cache key // - // * Includes the normalized header in the request to the origin - // - // If one or both of these fields are true, you should not whitelist the Accept-Encoding - // header in the cache policy or in an origin request policy attached to the - // same cache behavior. + // * Includes the normalized header in the request to the origin, if a request + // is necessary // // For more information, see Cache compressed objects (https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/controlling-the-cache-key.html#cache-policy-compressed-objects) // in the Amazon CloudFront Developer Guide. // + // If you set this value to true, and this cache behavior also has an origin + // request policy attached, do not include the Accept-Encoding header in the + // origin request policy. CloudFront always includes the Accept-Encoding header + // in origin requests when the value of this field is true, so including this + // header in an origin request policy has no effect. + // // If both of these fields are false, then CloudFront treats the Accept-Encoding // header the same as any other HTTP header in the viewer request. By default, // it’s not included in the cache key and it’s not included in origin requests. diff --git a/service/comprehend/api.go b/service/comprehend/api.go index aad805512a..4653b32b94 100644 --- a/service/comprehend/api.go +++ b/service/comprehend/api.go @@ -1845,6 +1845,95 @@ func (c *Comprehend) DescribeKeyPhrasesDetectionJobWithContext(ctx aws.Context, return out, req.Send() } +const opDescribePiiEntitiesDetectionJob = "DescribePiiEntitiesDetectionJob" + +// DescribePiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the DescribePiiEntitiesDetectionJob 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 DescribePiiEntitiesDetectionJob for more information on using the DescribePiiEntitiesDetectionJob +// 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 DescribePiiEntitiesDetectionJobRequest method. +// req, resp := client.DescribePiiEntitiesDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob +func (c *Comprehend) DescribePiiEntitiesDetectionJobRequest(input *DescribePiiEntitiesDetectionJobInput) (req *request.Request, output *DescribePiiEntitiesDetectionJobOutput) { + op := &request.Operation{ + Name: opDescribePiiEntitiesDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DescribePiiEntitiesDetectionJobInput{} + } + + output = &DescribePiiEntitiesDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// DescribePiiEntitiesDetectionJob API operation for Amazon Comprehend. +// +// Gets the properties associated with a PII entities detection job. For example, +// you can use this operation to get the job status. +// +// 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 Comprehend's +// API operation DescribePiiEntitiesDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * JobNotFoundException +// The specified job was not found. Check the job ID and try again. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DescribePiiEntitiesDetectionJob +func (c *Comprehend) DescribePiiEntitiesDetectionJob(input *DescribePiiEntitiesDetectionJobInput) (*DescribePiiEntitiesDetectionJobOutput, error) { + req, out := c.DescribePiiEntitiesDetectionJobRequest(input) + return out, req.Send() +} + +// DescribePiiEntitiesDetectionJobWithContext is the same as DescribePiiEntitiesDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See DescribePiiEntitiesDetectionJob 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 *Comprehend) DescribePiiEntitiesDetectionJobWithContext(ctx aws.Context, input *DescribePiiEntitiesDetectionJobInput, opts ...request.Option) (*DescribePiiEntitiesDetectionJobOutput, error) { + req, out := c.DescribePiiEntitiesDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDescribeSentimentDetectionJob = "DescribeSentimentDetectionJob" // DescribeSentimentDetectionJobRequest generates a "aws/request.Request" representing the @@ -2299,6 +2388,99 @@ func (c *Comprehend) DetectKeyPhrasesWithContext(ctx aws.Context, input *DetectK return out, req.Send() } +const opDetectPiiEntities = "DetectPiiEntities" + +// DetectPiiEntitiesRequest generates a "aws/request.Request" representing the +// client's request for the DetectPiiEntities 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 DetectPiiEntities for more information on using the DetectPiiEntities +// 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 DetectPiiEntitiesRequest method. +// req, resp := client.DetectPiiEntitiesRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities +func (c *Comprehend) DetectPiiEntitiesRequest(input *DetectPiiEntitiesInput) (req *request.Request, output *DetectPiiEntitiesOutput) { + op := &request.Operation{ + Name: opDetectPiiEntities, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &DetectPiiEntitiesInput{} + } + + output = &DetectPiiEntitiesOutput{} + req = c.newRequest(op, input, output) + return +} + +// DetectPiiEntities API operation for Amazon Comprehend. +// +// Inspects the input text for entities that contain personally identifiable +// information (PII) and returns information about them. +// +// 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 Comprehend's +// API operation DetectPiiEntities for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * TextSizeLimitExceededException +// The size of the input text exceeds the limit. Use a smaller document. +// +// * UnsupportedLanguageException +// Amazon Comprehend can't process the language of the input text. For all custom +// entity recognition APIs (such as CreateEntityRecognizer), only English, Spanish, +// French, Italian, German, or Portuguese are accepted. For most other APIs, +// such as those for Custom Classification, Amazon Comprehend accepts text in +// all supported languages. For a list of supported languages, see supported-languages. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/DetectPiiEntities +func (c *Comprehend) DetectPiiEntities(input *DetectPiiEntitiesInput) (*DetectPiiEntitiesOutput, error) { + req, out := c.DetectPiiEntitiesRequest(input) + return out, req.Send() +} + +// DetectPiiEntitiesWithContext is the same as DetectPiiEntities with the addition of +// the ability to pass a context and additional request options. +// +// See DetectPiiEntities 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 *Comprehend) DetectPiiEntitiesWithContext(ctx aws.Context, input *DetectPiiEntitiesInput, opts ...request.Option) (*DetectPiiEntitiesOutput, error) { + req, out := c.DetectPiiEntitiesRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opDetectSentiment = "DetectSentiment" // DetectSentimentRequest generates a "aws/request.Request" representing the @@ -3453,6 +3635,94 @@ func (c *Comprehend) ListKeyPhrasesDetectionJobsPagesWithContext(ctx aws.Context return p.Err() } +const opListPiiEntitiesDetectionJobs = "ListPiiEntitiesDetectionJobs" + +// ListPiiEntitiesDetectionJobsRequest generates a "aws/request.Request" representing the +// client's request for the ListPiiEntitiesDetectionJobs 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 ListPiiEntitiesDetectionJobs for more information on using the ListPiiEntitiesDetectionJobs +// 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 ListPiiEntitiesDetectionJobsRequest method. +// req, resp := client.ListPiiEntitiesDetectionJobsRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs +func (c *Comprehend) ListPiiEntitiesDetectionJobsRequest(input *ListPiiEntitiesDetectionJobsInput) (req *request.Request, output *ListPiiEntitiesDetectionJobsOutput) { + op := &request.Operation{ + Name: opListPiiEntitiesDetectionJobs, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &ListPiiEntitiesDetectionJobsInput{} + } + + output = &ListPiiEntitiesDetectionJobsOutput{} + req = c.newRequest(op, input, output) + return +} + +// ListPiiEntitiesDetectionJobs API operation for Amazon Comprehend. +// +// Gets a list of the PII entity detection jobs that you have submitted. +// +// 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 Comprehend's +// API operation ListPiiEntitiesDetectionJobs for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * InvalidFilterException +// The filter specified for the operation is invalid. Specify a different filter. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/ListPiiEntitiesDetectionJobs +func (c *Comprehend) ListPiiEntitiesDetectionJobs(input *ListPiiEntitiesDetectionJobsInput) (*ListPiiEntitiesDetectionJobsOutput, error) { + req, out := c.ListPiiEntitiesDetectionJobsRequest(input) + return out, req.Send() +} + +// ListPiiEntitiesDetectionJobsWithContext is the same as ListPiiEntitiesDetectionJobs with the addition of +// the ability to pass a context and additional request options. +// +// See ListPiiEntitiesDetectionJobs 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 *Comprehend) ListPiiEntitiesDetectionJobsWithContext(ctx aws.Context, input *ListPiiEntitiesDetectionJobsInput, opts ...request.Option) (*ListPiiEntitiesDetectionJobsOutput, error) { + req, out := c.ListPiiEntitiesDetectionJobsRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opListSentimentDetectionJobs = "ListSentimentDetectionJobs" // ListSentimentDetectionJobsRequest generates a "aws/request.Request" representing the @@ -4212,59 +4482,58 @@ func (c *Comprehend) StartKeyPhrasesDetectionJobWithContext(ctx aws.Context, inp return out, req.Send() } -const opStartSentimentDetectionJob = "StartSentimentDetectionJob" +const opStartPiiEntitiesDetectionJob = "StartPiiEntitiesDetectionJob" -// StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartSentimentDetectionJob operation. The "output" return +// StartPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartPiiEntitiesDetectionJob 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 StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob +// See StartPiiEntitiesDetectionJob for more information on using the StartPiiEntitiesDetectionJob // 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 StartSentimentDetectionJobRequest method. -// req, resp := client.StartSentimentDetectionJobRequest(params) +// // Example sending a request using the StartPiiEntitiesDetectionJobRequest method. +// req, resp := client.StartPiiEntitiesDetectionJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob -func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob +func (c *Comprehend) StartPiiEntitiesDetectionJobRequest(input *StartPiiEntitiesDetectionJobInput) (req *request.Request, output *StartPiiEntitiesDetectionJobOutput) { op := &request.Operation{ - Name: opStartSentimentDetectionJob, + Name: opStartPiiEntitiesDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartSentimentDetectionJobInput{} + input = &StartPiiEntitiesDetectionJobInput{} } - output = &StartSentimentDetectionJobOutput{} + output = &StartPiiEntitiesDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartSentimentDetectionJob API operation for Amazon Comprehend. +// StartPiiEntitiesDetectionJob API operation for Amazon Comprehend. // -// Starts an asynchronous sentiment detection job for a collection of documents. -// use the operation to track the status of a job. +// Starts an asynchronous PII entity detection job for a collection of documents. // // 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 Comprehend's -// API operation StartSentimentDetectionJob for usage and error information. +// API operation StartPiiEntitiesDetectionJob for usage and error information. // // Returned Error Types: // * InvalidRequestException @@ -4280,81 +4549,171 @@ func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDete // * InternalServerException // An internal server error occurred. Retry your request. // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob -func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error) { - req, out := c.StartSentimentDetectionJobRequest(input) +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartPiiEntitiesDetectionJob +func (c *Comprehend) StartPiiEntitiesDetectionJob(input *StartPiiEntitiesDetectionJobInput) (*StartPiiEntitiesDetectionJobOutput, error) { + req, out := c.StartPiiEntitiesDetectionJobRequest(input) return out, req.Send() } -// StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of +// StartPiiEntitiesDetectionJobWithContext is the same as StartPiiEntitiesDetectionJob with the addition of // the ability to pass a context and additional request options. // -// See StartSentimentDetectionJob for details on how to use this API operation. +// See StartPiiEntitiesDetectionJob 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 *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error) { - req, out := c.StartSentimentDetectionJobRequest(input) +func (c *Comprehend) StartPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StartPiiEntitiesDetectionJobInput, opts ...request.Option) (*StartPiiEntitiesDetectionJobOutput, error) { + req, out := c.StartPiiEntitiesDetectionJobRequest(input) req.SetContext(ctx) req.ApplyOptions(opts...) return out, req.Send() } -const opStartTopicsDetectionJob = "StartTopicsDetectionJob" +const opStartSentimentDetectionJob = "StartSentimentDetectionJob" -// StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the -// client's request for the StartTopicsDetectionJob operation. The "output" return +// StartSentimentDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartSentimentDetectionJob 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 StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob +// See StartSentimentDetectionJob for more information on using the StartSentimentDetectionJob // 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 StartTopicsDetectionJobRequest method. -// req, resp := client.StartTopicsDetectionJobRequest(params) +// // Example sending a request using the StartSentimentDetectionJobRequest method. +// req, resp := client.StartSentimentDetectionJobRequest(params) // // err := req.Send() // if err == nil { // resp is now filled // fmt.Println(resp) // } // -// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob -func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput) { +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob +func (c *Comprehend) StartSentimentDetectionJobRequest(input *StartSentimentDetectionJobInput) (req *request.Request, output *StartSentimentDetectionJobOutput) { op := &request.Operation{ - Name: opStartTopicsDetectionJob, + Name: opStartSentimentDetectionJob, HTTPMethod: "POST", HTTPPath: "/", } if input == nil { - input = &StartTopicsDetectionJobInput{} + input = &StartSentimentDetectionJobInput{} } - output = &StartTopicsDetectionJobOutput{} + output = &StartSentimentDetectionJobOutput{} req = c.newRequest(op, input, output) return } -// StartTopicsDetectionJob API operation for Amazon Comprehend. +// StartSentimentDetectionJob API operation for Amazon Comprehend. // -// Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob -// operation to track the status of a job. +// Starts an asynchronous sentiment detection job for a collection of documents. +// use the operation to track the status of a 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 Comprehend's -// API operation StartTopicsDetectionJob for usage and error information. +// API operation StartSentimentDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * TooManyRequestsException +// The number of requests exceeds the limit. Resubmit your request later. +// +// * KmsKeyValidationException +// The KMS customer managed key (CMK) entered cannot be validated. Verify the +// key and re-enter it. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartSentimentDetectionJob +func (c *Comprehend) StartSentimentDetectionJob(input *StartSentimentDetectionJobInput) (*StartSentimentDetectionJobOutput, error) { + req, out := c.StartSentimentDetectionJobRequest(input) + return out, req.Send() +} + +// StartSentimentDetectionJobWithContext is the same as StartSentimentDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See StartSentimentDetectionJob 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 *Comprehend) StartSentimentDetectionJobWithContext(ctx aws.Context, input *StartSentimentDetectionJobInput, opts ...request.Option) (*StartSentimentDetectionJobOutput, error) { + req, out := c.StartSentimentDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + +const opStartTopicsDetectionJob = "StartTopicsDetectionJob" + +// StartTopicsDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StartTopicsDetectionJob 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 StartTopicsDetectionJob for more information on using the StartTopicsDetectionJob +// 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 StartTopicsDetectionJobRequest method. +// req, resp := client.StartTopicsDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StartTopicsDetectionJob +func (c *Comprehend) StartTopicsDetectionJobRequest(input *StartTopicsDetectionJobInput) (req *request.Request, output *StartTopicsDetectionJobOutput) { + op := &request.Operation{ + Name: opStartTopicsDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StartTopicsDetectionJobInput{} + } + + output = &StartTopicsDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StartTopicsDetectionJob API operation for Amazon Comprehend. +// +// Starts an asynchronous topic detection job. Use the DescribeTopicDetectionJob +// operation to track the status of a 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 Comprehend's +// API operation StartTopicsDetectionJob for usage and error information. // // Returned Error Types: // * InvalidRequestException @@ -4680,6 +5039,91 @@ func (c *Comprehend) StopKeyPhrasesDetectionJobWithContext(ctx aws.Context, inpu return out, req.Send() } +const opStopPiiEntitiesDetectionJob = "StopPiiEntitiesDetectionJob" + +// StopPiiEntitiesDetectionJobRequest generates a "aws/request.Request" representing the +// client's request for the StopPiiEntitiesDetectionJob 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 StopPiiEntitiesDetectionJob for more information on using the StopPiiEntitiesDetectionJob +// 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 StopPiiEntitiesDetectionJobRequest method. +// req, resp := client.StopPiiEntitiesDetectionJobRequest(params) +// +// err := req.Send() +// if err == nil { // resp is now filled +// fmt.Println(resp) +// } +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob +func (c *Comprehend) StopPiiEntitiesDetectionJobRequest(input *StopPiiEntitiesDetectionJobInput) (req *request.Request, output *StopPiiEntitiesDetectionJobOutput) { + op := &request.Operation{ + Name: opStopPiiEntitiesDetectionJob, + HTTPMethod: "POST", + HTTPPath: "/", + } + + if input == nil { + input = &StopPiiEntitiesDetectionJobInput{} + } + + output = &StopPiiEntitiesDetectionJobOutput{} + req = c.newRequest(op, input, output) + return +} + +// StopPiiEntitiesDetectionJob API operation for Amazon Comprehend. +// +// Stops a PII entities detection job in progress. +// +// 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 Comprehend's +// API operation StopPiiEntitiesDetectionJob for usage and error information. +// +// Returned Error Types: +// * InvalidRequestException +// The request is invalid. +// +// * JobNotFoundException +// The specified job was not found. Check the job ID and try again. +// +// * InternalServerException +// An internal server error occurred. Retry your request. +// +// See also, https://docs.aws.amazon.com/goto/WebAPI/comprehend-2017-11-27/StopPiiEntitiesDetectionJob +func (c *Comprehend) StopPiiEntitiesDetectionJob(input *StopPiiEntitiesDetectionJobInput) (*StopPiiEntitiesDetectionJobOutput, error) { + req, out := c.StopPiiEntitiesDetectionJobRequest(input) + return out, req.Send() +} + +// StopPiiEntitiesDetectionJobWithContext is the same as StopPiiEntitiesDetectionJob with the addition of +// the ability to pass a context and additional request options. +// +// See StopPiiEntitiesDetectionJob 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 *Comprehend) StopPiiEntitiesDetectionJobWithContext(ctx aws.Context, input *StopPiiEntitiesDetectionJobInput, opts ...request.Option) (*StopPiiEntitiesDetectionJobOutput, error) { + req, out := c.StopPiiEntitiesDetectionJobRequest(input) + req.SetContext(ctx) + req.ApplyOptions(opts...) + return out, req.Send() +} + const opStopSentimentDetectionJob = "StopSentimentDetectionJob" // StopSentimentDetectionJobRequest generates a "aws/request.Request" representing the @@ -7458,6 +7902,71 @@ func (s *DescribeKeyPhrasesDetectionJobOutput) SetKeyPhrasesDetectionJobProperti return s } +type DescribePiiEntitiesDetectionJobInput struct { + _ struct{} `type:"structure"` + + // The identifier that Amazon Comprehend generated for the job. The operation + // returns this identifier in its response. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s DescribePiiEntitiesDetectionJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribePiiEntitiesDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DescribePiiEntitiesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DescribePiiEntitiesDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *DescribePiiEntitiesDetectionJobInput) SetJobId(v string) *DescribePiiEntitiesDetectionJobInput { + s.JobId = &v + return s +} + +type DescribePiiEntitiesDetectionJobOutput struct { + _ struct{} `type:"structure"` + + // Provides information about a PII entities detection job. + PiiEntitiesDetectionJobProperties *PiiEntitiesDetectionJobProperties `type:"structure"` +} + +// String returns the string representation +func (s DescribePiiEntitiesDetectionJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DescribePiiEntitiesDetectionJobOutput) GoString() string { + return s.String() +} + +// SetPiiEntitiesDetectionJobProperties sets the PiiEntitiesDetectionJobProperties field's value. +func (s *DescribePiiEntitiesDetectionJobOutput) SetPiiEntitiesDetectionJobProperties(v *PiiEntitiesDetectionJobProperties) *DescribePiiEntitiesDetectionJobOutput { + s.PiiEntitiesDetectionJobProperties = v + return s +} + type DescribeSentimentDetectionJobInput struct { _ struct{} `type:"structure"` @@ -7841,11 +8350,10 @@ func (s *DetectKeyPhrasesOutput) SetKeyPhrases(v []*KeyPhrase) *DetectKeyPhrases return s } -type DetectSentimentInput struct { +type DetectPiiEntitiesInput struct { _ struct{} `type:"structure"` - // The language of the input documents. You can specify any of the primary languages - // supported by Amazon Comprehend. All documents must be in the same language. + // The language of the input documents. // // LanguageCode is a required field LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` @@ -7854,22 +8362,22 @@ type DetectSentimentInput struct { // encoded characters. // // Text is a required field - Text *string `min:"1" type:"string" required:"true" sensitive:"true"` + Text *string `min:"1" type:"string" required:"true"` } // String returns the string representation -func (s DetectSentimentInput) String() string { +func (s DetectPiiEntitiesInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DetectSentimentInput) GoString() string { +func (s DetectPiiEntitiesInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DetectSentimentInput) Validate() error { - invalidParams := request.ErrInvalidParams{Context: "DetectSentimentInput"} +func (s *DetectPiiEntitiesInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectPiiEntitiesInput"} if s.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) } @@ -7887,79 +8395,161 @@ func (s *DetectSentimentInput) Validate() error { } // SetLanguageCode sets the LanguageCode field's value. -func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput { +func (s *DetectPiiEntitiesInput) SetLanguageCode(v string) *DetectPiiEntitiesInput { s.LanguageCode = &v return s } // SetText sets the Text field's value. -func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput { +func (s *DetectPiiEntitiesInput) SetText(v string) *DetectPiiEntitiesInput { s.Text = &v return s } -type DetectSentimentOutput struct { - _ struct{} `type:"structure" sensitive:"true"` - - // The inferred sentiment that Amazon Comprehend has the highest level of confidence - // in. - Sentiment *string `type:"string" enum:"SentimentType"` +type DetectPiiEntitiesOutput struct { + _ struct{} `type:"structure"` - // An object that lists the sentiments, and their corresponding confidence levels. - SentimentScore *SentimentScore `type:"structure"` + // A collection of PII entities identified in the input text. For each entity, + // the response provides the entity type, where the entity text begins and ends, + // and the level of confidence that Amazon Comprehend has in the detection. + Entities []*PiiEntity `type:"list"` } // String returns the string representation -func (s DetectSentimentOutput) String() string { +func (s DetectPiiEntitiesOutput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DetectSentimentOutput) GoString() string { +func (s DetectPiiEntitiesOutput) GoString() string { return s.String() } -// SetSentiment sets the Sentiment field's value. -func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput { - s.Sentiment = &v - return s -} - -// SetSentimentScore sets the SentimentScore field's value. -func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput { - s.SentimentScore = v +// SetEntities sets the Entities field's value. +func (s *DetectPiiEntitiesOutput) SetEntities(v []*PiiEntity) *DetectPiiEntitiesOutput { + s.Entities = v return s } -type DetectSyntaxInput struct { +type DetectSentimentInput struct { _ struct{} `type:"structure"` - // The language code of the input documents. You can specify any of the following - // languages supported by Amazon Comprehend: German ("de"), English ("en"), - // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). + // The language of the input documents. You can specify any of the primary languages + // supported by Amazon Comprehend. All documents must be in the same language. // // LanguageCode is a required field - LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` - // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded - // characters. + // A UTF-8 text string. Each string must contain fewer that 5,000 bytes of UTF-8 + // encoded characters. // // Text is a required field Text *string `min:"1" type:"string" required:"true" sensitive:"true"` } // String returns the string representation -func (s DetectSyntaxInput) String() string { +func (s DetectSentimentInput) String() string { return awsutil.Prettify(s) } // GoString returns the string representation -func (s DetectSyntaxInput) GoString() string { +func (s DetectSentimentInput) GoString() string { return s.String() } // Validate inspects the fields of the type to determine if they are valid. -func (s *DetectSyntaxInput) Validate() error { +func (s *DetectSentimentInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "DetectSentimentInput"} + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Text == nil { + invalidParams.Add(request.NewErrParamRequired("Text")) + } + if s.Text != nil && len(*s.Text) < 1 { + invalidParams.Add(request.NewErrParamMinLen("Text", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *DetectSentimentInput) SetLanguageCode(v string) *DetectSentimentInput { + s.LanguageCode = &v + return s +} + +// SetText sets the Text field's value. +func (s *DetectSentimentInput) SetText(v string) *DetectSentimentInput { + s.Text = &v + return s +} + +type DetectSentimentOutput struct { + _ struct{} `type:"structure" sensitive:"true"` + + // The inferred sentiment that Amazon Comprehend has the highest level of confidence + // in. + Sentiment *string `type:"string" enum:"SentimentType"` + + // An object that lists the sentiments, and their corresponding confidence levels. + SentimentScore *SentimentScore `type:"structure"` +} + +// String returns the string representation +func (s DetectSentimentOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DetectSentimentOutput) GoString() string { + return s.String() +} + +// SetSentiment sets the Sentiment field's value. +func (s *DetectSentimentOutput) SetSentiment(v string) *DetectSentimentOutput { + s.Sentiment = &v + return s +} + +// SetSentimentScore sets the SentimentScore field's value. +func (s *DetectSentimentOutput) SetSentimentScore(v *SentimentScore) *DetectSentimentOutput { + s.SentimentScore = v + return s +} + +type DetectSyntaxInput struct { + _ struct{} `type:"structure"` + + // The language code of the input documents. You can specify any of the following + // languages supported by Amazon Comprehend: German ("de"), English ("en"), + // Spanish ("es"), French ("fr"), Italian ("it"), or Portuguese ("pt"). + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"SyntaxLanguageCode"` + + // A UTF-8 string. Each string must contain fewer that 5,000 bytes of UTF encoded + // characters. + // + // Text is a required field + Text *string `min:"1" type:"string" required:"true" sensitive:"true"` +} + +// String returns the string representation +func (s DetectSyntaxInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s DetectSyntaxInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *DetectSyntaxInput) Validate() error { invalidParams := request.ErrInvalidParams{Context: "DetectSyntaxInput"} if s.LanguageCode == nil { invalidParams.Add(request.NewErrParamRequired("LanguageCode")) @@ -11197,6 +11787,102 @@ func (s *ListKeyPhrasesDetectionJobsOutput) SetNextToken(v string) *ListKeyPhras return s } +type ListPiiEntitiesDetectionJobsInput struct { + _ struct{} `type:"structure"` + + // Filters the jobs that are returned. You can filter jobs on their name, status, + // or the date and time that they were submitted. You can only set one filter + // at a time. + Filter *PiiEntitiesDetectionJobFilter `type:"structure"` + + // The maximum number of results to return in each page. + MaxResults *int64 `min:"1" type:"integer"` + + // Identifies the next page of results to return. + NextToken *string `min:"1" type:"string"` +} + +// String returns the string representation +func (s ListPiiEntitiesDetectionJobsInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListPiiEntitiesDetectionJobsInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *ListPiiEntitiesDetectionJobsInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "ListPiiEntitiesDetectionJobsInput"} + 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.Filter != nil { + if err := s.Filter.Validate(); err != nil { + invalidParams.AddNested("Filter", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetFilter sets the Filter field's value. +func (s *ListPiiEntitiesDetectionJobsInput) SetFilter(v *PiiEntitiesDetectionJobFilter) *ListPiiEntitiesDetectionJobsInput { + s.Filter = v + return s +} + +// SetMaxResults sets the MaxResults field's value. +func (s *ListPiiEntitiesDetectionJobsInput) SetMaxResults(v int64) *ListPiiEntitiesDetectionJobsInput { + s.MaxResults = &v + return s +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPiiEntitiesDetectionJobsInput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsInput { + s.NextToken = &v + return s +} + +type ListPiiEntitiesDetectionJobsOutput struct { + _ struct{} `type:"structure"` + + // Identifies the next page of results to return. + NextToken *string `min:"1" type:"string"` + + // A list containing the properties of each job that is returned. + PiiEntitiesDetectionJobPropertiesList []*PiiEntitiesDetectionJobProperties `type:"list"` +} + +// String returns the string representation +func (s ListPiiEntitiesDetectionJobsOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s ListPiiEntitiesDetectionJobsOutput) GoString() string { + return s.String() +} + +// SetNextToken sets the NextToken field's value. +func (s *ListPiiEntitiesDetectionJobsOutput) SetNextToken(v string) *ListPiiEntitiesDetectionJobsOutput { + s.NextToken = &v + return s +} + +// SetPiiEntitiesDetectionJobPropertiesList sets the PiiEntitiesDetectionJobPropertiesList field's value. +func (s *ListPiiEntitiesDetectionJobsOutput) SetPiiEntitiesDetectionJobPropertiesList(v []*PiiEntitiesDetectionJobProperties) *ListPiiEntitiesDetectionJobsOutput { + s.PiiEntitiesDetectionJobPropertiesList = v + return s +} + type ListSentimentDetectionJobsInput struct { _ struct{} `type:"structure"` @@ -11556,15 +12242,369 @@ func (s PartOfSpeechTag) GoString() string { return s.String() } -// SetScore sets the Score field's value. -func (s *PartOfSpeechTag) SetScore(v float64) *PartOfSpeechTag { - s.Score = &v +// SetScore sets the Score field's value. +func (s *PartOfSpeechTag) SetScore(v float64) *PartOfSpeechTag { + s.Score = &v + return s +} + +// SetTag sets the Tag field's value. +func (s *PartOfSpeechTag) SetTag(v string) *PartOfSpeechTag { + s.Tag = &v + return s +} + +// Provides information for filtering a list of PII entity detection jobs. +type PiiEntitiesDetectionJobFilter struct { + _ struct{} `type:"structure"` + + // Filters on the name of the job. + JobName *string `min:"1" type:"string"` + + // Filters the list of jobs based on job status. Returns only jobs with the + // specified status. + JobStatus *string `type:"string" enum:"JobStatus"` + + // Filters the list of jobs based on the time that the job was submitted for + // processing. Returns only jobs submitted after the specified time. Jobs are + // returned in descending order, newest to oldest. + SubmitTimeAfter *time.Time `type:"timestamp"` + + // Filters the list of jobs based on the time that the job was submitted for + // processing. Returns only jobs submitted before the specified time. Jobs are + // returned in ascending order, oldest to newest. + SubmitTimeBefore *time.Time `type:"timestamp"` +} + +// String returns the string representation +func (s PiiEntitiesDetectionJobFilter) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PiiEntitiesDetectionJobFilter) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *PiiEntitiesDetectionJobFilter) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "PiiEntitiesDetectionJobFilter"} + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobName sets the JobName field's value. +func (s *PiiEntitiesDetectionJobFilter) SetJobName(v string) *PiiEntitiesDetectionJobFilter { + s.JobName = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *PiiEntitiesDetectionJobFilter) SetJobStatus(v string) *PiiEntitiesDetectionJobFilter { + s.JobStatus = &v + return s +} + +// SetSubmitTimeAfter sets the SubmitTimeAfter field's value. +func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeAfter(v time.Time) *PiiEntitiesDetectionJobFilter { + s.SubmitTimeAfter = &v + return s +} + +// SetSubmitTimeBefore sets the SubmitTimeBefore field's value. +func (s *PiiEntitiesDetectionJobFilter) SetSubmitTimeBefore(v time.Time) *PiiEntitiesDetectionJobFilter { + s.SubmitTimeBefore = &v + return s +} + +// Provides information about a PII entities detection job. +type PiiEntitiesDetectionJobProperties struct { + _ struct{} `type:"structure"` + + // The Amazon Resource Name (ARN) that gives Amazon Comprehend read access to + // your input data. + DataAccessRoleArn *string `min:"20" type:"string"` + + // The time that the PII entities detection job completed. + EndTime *time.Time `type:"timestamp"` + + // The input properties for a PII entities detection job. + InputDataConfig *InputDataConfig `type:"structure"` + + // The identifier assigned to the PII entities detection job. + JobId *string `min:"1" type:"string"` + + // The name that you assigned the PII entities detection job. + JobName *string `min:"1" type:"string"` + + // The current status of the PII entities detection job. If the status is FAILED, + // the Message field shows the reason for the failure. + JobStatus *string `type:"string" enum:"JobStatus"` + + // The language code of the input documents + LanguageCode *string `type:"string" enum:"LanguageCode"` + + // A description of the status of a job. + Message *string `type:"string"` + + // Specifies whether the output provides the locations (offsets) of PII entities + // or a file in which PII entities are redacted. + Mode *string `type:"string" enum:"PiiEntitiesDetectionMode"` + + // The output data configuration that you supplied when you created the PII + // entities detection job. + OutputDataConfig *PiiOutputDataConfig `type:"structure"` + + // Provides configuration parameters for PII entity redaction. + // + // This parameter is required if you set the Mode parameter to ONLY_REDACTION. + // In that case, you must provide a RedactionConfig definition that includes + // the PiiEntityTypes parameter. + RedactionConfig *RedactionConfig `type:"structure"` + + // The time that the PII entities detection job was submitted for processing. + SubmitTime *time.Time `type:"timestamp"` +} + +// String returns the string representation +func (s PiiEntitiesDetectionJobProperties) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PiiEntitiesDetectionJobProperties) GoString() string { + return s.String() +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *PiiEntitiesDetectionJobProperties) SetDataAccessRoleArn(v string) *PiiEntitiesDetectionJobProperties { + s.DataAccessRoleArn = &v + return s +} + +// SetEndTime sets the EndTime field's value. +func (s *PiiEntitiesDetectionJobProperties) SetEndTime(v time.Time) *PiiEntitiesDetectionJobProperties { + s.EndTime = &v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *PiiEntitiesDetectionJobProperties) SetInputDataConfig(v *InputDataConfig) *PiiEntitiesDetectionJobProperties { + s.InputDataConfig = v + return s +} + +// SetJobId sets the JobId field's value. +func (s *PiiEntitiesDetectionJobProperties) SetJobId(v string) *PiiEntitiesDetectionJobProperties { + s.JobId = &v + return s +} + +// SetJobName sets the JobName field's value. +func (s *PiiEntitiesDetectionJobProperties) SetJobName(v string) *PiiEntitiesDetectionJobProperties { + s.JobName = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *PiiEntitiesDetectionJobProperties) SetJobStatus(v string) *PiiEntitiesDetectionJobProperties { + s.JobStatus = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *PiiEntitiesDetectionJobProperties) SetLanguageCode(v string) *PiiEntitiesDetectionJobProperties { + s.LanguageCode = &v + return s +} + +// SetMessage sets the Message field's value. +func (s *PiiEntitiesDetectionJobProperties) SetMessage(v string) *PiiEntitiesDetectionJobProperties { + s.Message = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *PiiEntitiesDetectionJobProperties) SetMode(v string) *PiiEntitiesDetectionJobProperties { + s.Mode = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *PiiEntitiesDetectionJobProperties) SetOutputDataConfig(v *PiiOutputDataConfig) *PiiEntitiesDetectionJobProperties { + s.OutputDataConfig = v + return s +} + +// SetRedactionConfig sets the RedactionConfig field's value. +func (s *PiiEntitiesDetectionJobProperties) SetRedactionConfig(v *RedactionConfig) *PiiEntitiesDetectionJobProperties { + s.RedactionConfig = v + return s +} + +// SetSubmitTime sets the SubmitTime field's value. +func (s *PiiEntitiesDetectionJobProperties) SetSubmitTime(v time.Time) *PiiEntitiesDetectionJobProperties { + s.SubmitTime = &v + return s +} + +// Provides information about a PII entity. +type PiiEntity struct { + _ struct{} `type:"structure"` + + // A character offset in the input text that shows where the PII entity begins + // (the first character is at position 0). The offset returns the position of + // each UTF-8 code point in the string. A code point is the abstract character + // from a particular graphical representation. For example, a multi-byte UTF-8 + // character maps to a single code point. + BeginOffset *int64 `type:"integer"` + + // A character offset in the input text that shows where the PII entity ends. + // The offset returns the position of each UTF-8 code point in the string. A + // code point is the abstract character from a particular graphical representation. + // For example, a multi-byte UTF-8 character maps to a single code point. + EndOffset *int64 `type:"integer"` + + // The level of confidence that Amazon Comprehend has in the accuracy of the + // detection. + Score *float64 `type:"float"` + + // The entity's type. + Type *string `type:"string" enum:"PiiEntityType"` +} + +// String returns the string representation +func (s PiiEntity) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PiiEntity) GoString() string { + return s.String() +} + +// SetBeginOffset sets the BeginOffset field's value. +func (s *PiiEntity) SetBeginOffset(v int64) *PiiEntity { + s.BeginOffset = &v + return s +} + +// SetEndOffset sets the EndOffset field's value. +func (s *PiiEntity) SetEndOffset(v int64) *PiiEntity { + s.EndOffset = &v + return s +} + +// SetScore sets the Score field's value. +func (s *PiiEntity) SetScore(v float64) *PiiEntity { + s.Score = &v + return s +} + +// SetType sets the Type field's value. +func (s *PiiEntity) SetType(v string) *PiiEntity { + s.Type = &v + return s +} + +// Provides configuration parameters for the output of PII entity detection +// jobs. +type PiiOutputDataConfig struct { + _ struct{} `type:"structure"` + + // ID for the AWS Key Management Service (KMS) key that Amazon Comprehend uses + // to encrypt the output results from an analysis job. + KmsKeyId *string `type:"string"` + + // When you use the PiiOutputDataConfig object with asynchronous operations, + // you specify the Amazon S3 location where you want to write the output data. + // + // S3Uri is a required field + S3Uri *string `type:"string" required:"true"` +} + +// String returns the string representation +func (s PiiOutputDataConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s PiiOutputDataConfig) GoString() string { + return s.String() +} + +// SetKmsKeyId sets the KmsKeyId field's value. +func (s *PiiOutputDataConfig) SetKmsKeyId(v string) *PiiOutputDataConfig { + s.KmsKeyId = &v + return s +} + +// SetS3Uri sets the S3Uri field's value. +func (s *PiiOutputDataConfig) SetS3Uri(v string) *PiiOutputDataConfig { + s.S3Uri = &v + return s +} + +// Provides configuration parameters for PII entity redaction. +type RedactionConfig struct { + _ struct{} `type:"structure"` + + // A character that replaces each character in the redacted PII entity. + MaskCharacter *string `min:"1" type:"string"` + + // Specifies whether the PII entity is redacted with the mask character or the + // entity type. + MaskMode *string `type:"string" enum:"PiiEntitiesDetectionMaskMode"` + + // An array of the types of PII entities that Amazon Comprehend detects in the + // input text for your request. + PiiEntityTypes []*string `type:"list"` +} + +// String returns the string representation +func (s RedactionConfig) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s RedactionConfig) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *RedactionConfig) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "RedactionConfig"} + if s.MaskCharacter != nil && len(*s.MaskCharacter) < 1 { + invalidParams.Add(request.NewErrParamMinLen("MaskCharacter", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetMaskCharacter sets the MaskCharacter field's value. +func (s *RedactionConfig) SetMaskCharacter(v string) *RedactionConfig { + s.MaskCharacter = &v + return s +} + +// SetMaskMode sets the MaskMode field's value. +func (s *RedactionConfig) SetMaskMode(v string) *RedactionConfig { + s.MaskMode = &v return s } -// SetTag sets the Tag field's value. -func (s *PartOfSpeechTag) SetTag(v string) *PartOfSpeechTag { - s.Tag = &v +// SetPiiEntityTypes sets the PiiEntityTypes field's value. +func (s *RedactionConfig) SetPiiEntityTypes(v []*string) *RedactionConfig { + s.PiiEntityTypes = v return s } @@ -12844,6 +13884,191 @@ func (s *StartKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StartKeyPhra return s } +type StartPiiEntitiesDetectionJobInput struct { + _ struct{} `type:"structure"` + + // A unique identifier for the request. If you don't set the client request + // token, Amazon Comprehend generates one. + ClientRequestToken *string `min:"1" type:"string" idempotencyToken:"true"` + + // The Amazon Resource Name (ARN) of the AWS Identity and Access Management + // (IAM) role that grants Amazon Comprehend read access to your input data. + // + // DataAccessRoleArn is a required field + DataAccessRoleArn *string `min:"20" type:"string" required:"true"` + + // The input properties for a PII entities detection job. + // + // InputDataConfig is a required field + InputDataConfig *InputDataConfig `type:"structure" required:"true"` + + // The identifier of the job. + JobName *string `min:"1" type:"string"` + + // The language of the input documents. + // + // LanguageCode is a required field + LanguageCode *string `type:"string" required:"true" enum:"LanguageCode"` + + // Specifies whether the output provides the locations (offsets) of PII entities + // or a file in which PII entities are redacted. + // + // Mode is a required field + Mode *string `type:"string" required:"true" enum:"PiiEntitiesDetectionMode"` + + // Provides configuration parameters for the output of PII entity detection + // jobs. + // + // OutputDataConfig is a required field + OutputDataConfig *OutputDataConfig `type:"structure" required:"true"` + + // Provides configuration parameters for PII entity redaction. + // + // This parameter is required if you set the Mode parameter to ONLY_REDACTION. + // In that case, you must provide a RedactionConfig definition that includes + // the PiiEntityTypes parameter. + RedactionConfig *RedactionConfig `type:"structure"` +} + +// String returns the string representation +func (s StartPiiEntitiesDetectionJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartPiiEntitiesDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StartPiiEntitiesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StartPiiEntitiesDetectionJobInput"} + if s.ClientRequestToken != nil && len(*s.ClientRequestToken) < 1 { + invalidParams.Add(request.NewErrParamMinLen("ClientRequestToken", 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.InputDataConfig == nil { + invalidParams.Add(request.NewErrParamRequired("InputDataConfig")) + } + if s.JobName != nil && len(*s.JobName) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobName", 1)) + } + if s.LanguageCode == nil { + invalidParams.Add(request.NewErrParamRequired("LanguageCode")) + } + if s.Mode == nil { + invalidParams.Add(request.NewErrParamRequired("Mode")) + } + 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 s.RedactionConfig != nil { + if err := s.RedactionConfig.Validate(); err != nil { + invalidParams.AddNested("RedactionConfig", err.(request.ErrInvalidParams)) + } + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetClientRequestToken sets the ClientRequestToken field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetClientRequestToken(v string) *StartPiiEntitiesDetectionJobInput { + s.ClientRequestToken = &v + return s +} + +// SetDataAccessRoleArn sets the DataAccessRoleArn field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetDataAccessRoleArn(v string) *StartPiiEntitiesDetectionJobInput { + s.DataAccessRoleArn = &v + return s +} + +// SetInputDataConfig sets the InputDataConfig field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetInputDataConfig(v *InputDataConfig) *StartPiiEntitiesDetectionJobInput { + s.InputDataConfig = v + return s +} + +// SetJobName sets the JobName field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetJobName(v string) *StartPiiEntitiesDetectionJobInput { + s.JobName = &v + return s +} + +// SetLanguageCode sets the LanguageCode field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetLanguageCode(v string) *StartPiiEntitiesDetectionJobInput { + s.LanguageCode = &v + return s +} + +// SetMode sets the Mode field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetMode(v string) *StartPiiEntitiesDetectionJobInput { + s.Mode = &v + return s +} + +// SetOutputDataConfig sets the OutputDataConfig field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetOutputDataConfig(v *OutputDataConfig) *StartPiiEntitiesDetectionJobInput { + s.OutputDataConfig = v + return s +} + +// SetRedactionConfig sets the RedactionConfig field's value. +func (s *StartPiiEntitiesDetectionJobInput) SetRedactionConfig(v *RedactionConfig) *StartPiiEntitiesDetectionJobInput { + s.RedactionConfig = v + return s +} + +type StartPiiEntitiesDetectionJobOutput struct { + _ struct{} `type:"structure"` + + // The identifier generated for the job. + JobId *string `min:"1" type:"string"` + + // The status of the job. + JobStatus *string `type:"string" enum:"JobStatus"` +} + +// String returns the string representation +func (s StartPiiEntitiesDetectionJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StartPiiEntitiesDetectionJobOutput) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *StartPiiEntitiesDetectionJobOutput) SetJobId(v string) *StartPiiEntitiesDetectionJobOutput { + s.JobId = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *StartPiiEntitiesDetectionJobOutput) SetJobStatus(v string) *StartPiiEntitiesDetectionJobOutput { + s.JobStatus = &v + return s +} + type StartSentimentDetectionJobInput struct { _ struct{} `type:"structure"` @@ -13456,6 +14681,79 @@ func (s *StopKeyPhrasesDetectionJobOutput) SetJobStatus(v string) *StopKeyPhrase return s } +type StopPiiEntitiesDetectionJobInput struct { + _ struct{} `type:"structure"` + + // The identifier of the PII entities detection job to stop. + // + // JobId is a required field + JobId *string `min:"1" type:"string" required:"true"` +} + +// String returns the string representation +func (s StopPiiEntitiesDetectionJobInput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StopPiiEntitiesDetectionJobInput) GoString() string { + return s.String() +} + +// Validate inspects the fields of the type to determine if they are valid. +func (s *StopPiiEntitiesDetectionJobInput) Validate() error { + invalidParams := request.ErrInvalidParams{Context: "StopPiiEntitiesDetectionJobInput"} + if s.JobId == nil { + invalidParams.Add(request.NewErrParamRequired("JobId")) + } + if s.JobId != nil && len(*s.JobId) < 1 { + invalidParams.Add(request.NewErrParamMinLen("JobId", 1)) + } + + if invalidParams.Len() > 0 { + return invalidParams + } + return nil +} + +// SetJobId sets the JobId field's value. +func (s *StopPiiEntitiesDetectionJobInput) SetJobId(v string) *StopPiiEntitiesDetectionJobInput { + s.JobId = &v + return s +} + +type StopPiiEntitiesDetectionJobOutput struct { + _ struct{} `type:"structure"` + + // The identifier of the PII entities detection job to stop. + JobId *string `min:"1" type:"string"` + + // The status of the PII entities detection job. + JobStatus *string `type:"string" enum:"JobStatus"` +} + +// String returns the string representation +func (s StopPiiEntitiesDetectionJobOutput) String() string { + return awsutil.Prettify(s) +} + +// GoString returns the string representation +func (s StopPiiEntitiesDetectionJobOutput) GoString() string { + return s.String() +} + +// SetJobId sets the JobId field's value. +func (s *StopPiiEntitiesDetectionJobOutput) SetJobId(v string) *StopPiiEntitiesDetectionJobOutput { + s.JobId = &v + return s +} + +// SetJobStatus sets the JobStatus field's value. +func (s *StopPiiEntitiesDetectionJobOutput) SetJobStatus(v string) *StopPiiEntitiesDetectionJobOutput { + s.JobStatus = &v + return s +} + type StopSentimentDetectionJobInput struct { _ struct{} `type:"structure"` @@ -14851,6 +16149,138 @@ func PartOfSpeechTagType_Values() []string { } } +const ( + // PiiEntitiesDetectionMaskModeMask is a PiiEntitiesDetectionMaskMode enum value + PiiEntitiesDetectionMaskModeMask = "MASK" + + // PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType is a PiiEntitiesDetectionMaskMode enum value + PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType = "REPLACE_WITH_PII_ENTITY_TYPE" +) + +// PiiEntitiesDetectionMaskMode_Values returns all elements of the PiiEntitiesDetectionMaskMode enum +func PiiEntitiesDetectionMaskMode_Values() []string { + return []string{ + PiiEntitiesDetectionMaskModeMask, + PiiEntitiesDetectionMaskModeReplaceWithPiiEntityType, + } +} + +const ( + // PiiEntitiesDetectionModeOnlyRedaction is a PiiEntitiesDetectionMode enum value + PiiEntitiesDetectionModeOnlyRedaction = "ONLY_REDACTION" + + // PiiEntitiesDetectionModeOnlyOffsets is a PiiEntitiesDetectionMode enum value + PiiEntitiesDetectionModeOnlyOffsets = "ONLY_OFFSETS" +) + +// PiiEntitiesDetectionMode_Values returns all elements of the PiiEntitiesDetectionMode enum +func PiiEntitiesDetectionMode_Values() []string { + return []string{ + PiiEntitiesDetectionModeOnlyRedaction, + PiiEntitiesDetectionModeOnlyOffsets, + } +} + +const ( + // PiiEntityTypeBankAccountNumber is a PiiEntityType enum value + PiiEntityTypeBankAccountNumber = "BANK_ACCOUNT_NUMBER" + + // PiiEntityTypeBankRouting is a PiiEntityType enum value + PiiEntityTypeBankRouting = "BANK_ROUTING" + + // PiiEntityTypeCreditDebitNumber is a PiiEntityType enum value + PiiEntityTypeCreditDebitNumber = "CREDIT_DEBIT_NUMBER" + + // PiiEntityTypeCreditDebitCvv is a PiiEntityType enum value + PiiEntityTypeCreditDebitCvv = "CREDIT_DEBIT_CVV" + + // PiiEntityTypeCreditDebitExpiry is a PiiEntityType enum value + PiiEntityTypeCreditDebitExpiry = "CREDIT_DEBIT_EXPIRY" + + // PiiEntityTypePin is a PiiEntityType enum value + PiiEntityTypePin = "PIN" + + // PiiEntityTypeEmail is a PiiEntityType enum value + PiiEntityTypeEmail = "EMAIL" + + // PiiEntityTypeAddress is a PiiEntityType enum value + PiiEntityTypeAddress = "ADDRESS" + + // PiiEntityTypeName is a PiiEntityType enum value + PiiEntityTypeName = "NAME" + + // PiiEntityTypePhone is a PiiEntityType enum value + PiiEntityTypePhone = "PHONE" + + // PiiEntityTypeSsn is a PiiEntityType enum value + PiiEntityTypeSsn = "SSN" + + // PiiEntityTypeDateTime is a PiiEntityType enum value + PiiEntityTypeDateTime = "DATE_TIME" + + // PiiEntityTypePassportNumber is a PiiEntityType enum value + PiiEntityTypePassportNumber = "PASSPORT_NUMBER" + + // PiiEntityTypeDriverId is a PiiEntityType enum value + PiiEntityTypeDriverId = "DRIVER_ID" + + // PiiEntityTypeUrl is a PiiEntityType enum value + PiiEntityTypeUrl = "URL" + + // PiiEntityTypeAge is a PiiEntityType enum value + PiiEntityTypeAge = "AGE" + + // PiiEntityTypeUsername is a PiiEntityType enum value + PiiEntityTypeUsername = "USERNAME" + + // PiiEntityTypePassword is a PiiEntityType enum value + PiiEntityTypePassword = "PASSWORD" + + // PiiEntityTypeAwsAccessKey is a PiiEntityType enum value + PiiEntityTypeAwsAccessKey = "AWS_ACCESS_KEY" + + // PiiEntityTypeAwsSecretKey is a PiiEntityType enum value + PiiEntityTypeAwsSecretKey = "AWS_SECRET_KEY" + + // PiiEntityTypeIpAddress is a PiiEntityType enum value + PiiEntityTypeIpAddress = "IP_ADDRESS" + + // PiiEntityTypeMacAddress is a PiiEntityType enum value + PiiEntityTypeMacAddress = "MAC_ADDRESS" + + // PiiEntityTypeAll is a PiiEntityType enum value + PiiEntityTypeAll = "ALL" +) + +// PiiEntityType_Values returns all elements of the PiiEntityType enum +func PiiEntityType_Values() []string { + return []string{ + PiiEntityTypeBankAccountNumber, + PiiEntityTypeBankRouting, + PiiEntityTypeCreditDebitNumber, + PiiEntityTypeCreditDebitCvv, + PiiEntityTypeCreditDebitExpiry, + PiiEntityTypePin, + PiiEntityTypeEmail, + PiiEntityTypeAddress, + PiiEntityTypeName, + PiiEntityTypePhone, + PiiEntityTypeSsn, + PiiEntityTypeDateTime, + PiiEntityTypePassportNumber, + PiiEntityTypeDriverId, + PiiEntityTypeUrl, + PiiEntityTypeAge, + PiiEntityTypeUsername, + PiiEntityTypePassword, + PiiEntityTypeAwsAccessKey, + PiiEntityTypeAwsSecretKey, + PiiEntityTypeIpAddress, + PiiEntityTypeMacAddress, + PiiEntityTypeAll, + } +} + const ( // SentimentTypePositive is a SentimentType enum value SentimentTypePositive = "POSITIVE" diff --git a/service/comprehend/comprehendiface/interface.go b/service/comprehend/comprehendiface/interface.go index 2776a37557..50799bba75 100644 --- a/service/comprehend/comprehendiface/interface.go +++ b/service/comprehend/comprehendiface/interface.go @@ -136,6 +136,10 @@ type ComprehendAPI interface { DescribeKeyPhrasesDetectionJobWithContext(aws.Context, *comprehend.DescribeKeyPhrasesDetectionJobInput, ...request.Option) (*comprehend.DescribeKeyPhrasesDetectionJobOutput, error) DescribeKeyPhrasesDetectionJobRequest(*comprehend.DescribeKeyPhrasesDetectionJobInput) (*request.Request, *comprehend.DescribeKeyPhrasesDetectionJobOutput) + DescribePiiEntitiesDetectionJob(*comprehend.DescribePiiEntitiesDetectionJobInput) (*comprehend.DescribePiiEntitiesDetectionJobOutput, error) + DescribePiiEntitiesDetectionJobWithContext(aws.Context, *comprehend.DescribePiiEntitiesDetectionJobInput, ...request.Option) (*comprehend.DescribePiiEntitiesDetectionJobOutput, error) + DescribePiiEntitiesDetectionJobRequest(*comprehend.DescribePiiEntitiesDetectionJobInput) (*request.Request, *comprehend.DescribePiiEntitiesDetectionJobOutput) + DescribeSentimentDetectionJob(*comprehend.DescribeSentimentDetectionJobInput) (*comprehend.DescribeSentimentDetectionJobOutput, error) DescribeSentimentDetectionJobWithContext(aws.Context, *comprehend.DescribeSentimentDetectionJobInput, ...request.Option) (*comprehend.DescribeSentimentDetectionJobOutput, error) DescribeSentimentDetectionJobRequest(*comprehend.DescribeSentimentDetectionJobInput) (*request.Request, *comprehend.DescribeSentimentDetectionJobOutput) @@ -156,6 +160,10 @@ type ComprehendAPI interface { DetectKeyPhrasesWithContext(aws.Context, *comprehend.DetectKeyPhrasesInput, ...request.Option) (*comprehend.DetectKeyPhrasesOutput, error) DetectKeyPhrasesRequest(*comprehend.DetectKeyPhrasesInput) (*request.Request, *comprehend.DetectKeyPhrasesOutput) + DetectPiiEntities(*comprehend.DetectPiiEntitiesInput) (*comprehend.DetectPiiEntitiesOutput, error) + DetectPiiEntitiesWithContext(aws.Context, *comprehend.DetectPiiEntitiesInput, ...request.Option) (*comprehend.DetectPiiEntitiesOutput, error) + DetectPiiEntitiesRequest(*comprehend.DetectPiiEntitiesInput) (*request.Request, *comprehend.DetectPiiEntitiesOutput) + DetectSentiment(*comprehend.DetectSentimentInput) (*comprehend.DetectSentimentOutput, error) DetectSentimentWithContext(aws.Context, *comprehend.DetectSentimentInput, ...request.Option) (*comprehend.DetectSentimentOutput, error) DetectSentimentRequest(*comprehend.DetectSentimentInput) (*request.Request, *comprehend.DetectSentimentOutput) @@ -210,6 +218,10 @@ type ComprehendAPI interface { ListKeyPhrasesDetectionJobsPages(*comprehend.ListKeyPhrasesDetectionJobsInput, func(*comprehend.ListKeyPhrasesDetectionJobsOutput, bool) bool) error ListKeyPhrasesDetectionJobsPagesWithContext(aws.Context, *comprehend.ListKeyPhrasesDetectionJobsInput, func(*comprehend.ListKeyPhrasesDetectionJobsOutput, bool) bool, ...request.Option) error + ListPiiEntitiesDetectionJobs(*comprehend.ListPiiEntitiesDetectionJobsInput) (*comprehend.ListPiiEntitiesDetectionJobsOutput, error) + ListPiiEntitiesDetectionJobsWithContext(aws.Context, *comprehend.ListPiiEntitiesDetectionJobsInput, ...request.Option) (*comprehend.ListPiiEntitiesDetectionJobsOutput, error) + ListPiiEntitiesDetectionJobsRequest(*comprehend.ListPiiEntitiesDetectionJobsInput) (*request.Request, *comprehend.ListPiiEntitiesDetectionJobsOutput) + ListSentimentDetectionJobs(*comprehend.ListSentimentDetectionJobsInput) (*comprehend.ListSentimentDetectionJobsOutput, error) ListSentimentDetectionJobsWithContext(aws.Context, *comprehend.ListSentimentDetectionJobsInput, ...request.Option) (*comprehend.ListSentimentDetectionJobsOutput, error) ListSentimentDetectionJobsRequest(*comprehend.ListSentimentDetectionJobsInput) (*request.Request, *comprehend.ListSentimentDetectionJobsOutput) @@ -244,6 +256,10 @@ type ComprehendAPI interface { StartKeyPhrasesDetectionJobWithContext(aws.Context, *comprehend.StartKeyPhrasesDetectionJobInput, ...request.Option) (*comprehend.StartKeyPhrasesDetectionJobOutput, error) StartKeyPhrasesDetectionJobRequest(*comprehend.StartKeyPhrasesDetectionJobInput) (*request.Request, *comprehend.StartKeyPhrasesDetectionJobOutput) + StartPiiEntitiesDetectionJob(*comprehend.StartPiiEntitiesDetectionJobInput) (*comprehend.StartPiiEntitiesDetectionJobOutput, error) + StartPiiEntitiesDetectionJobWithContext(aws.Context, *comprehend.StartPiiEntitiesDetectionJobInput, ...request.Option) (*comprehend.StartPiiEntitiesDetectionJobOutput, error) + StartPiiEntitiesDetectionJobRequest(*comprehend.StartPiiEntitiesDetectionJobInput) (*request.Request, *comprehend.StartPiiEntitiesDetectionJobOutput) + StartSentimentDetectionJob(*comprehend.StartSentimentDetectionJobInput) (*comprehend.StartSentimentDetectionJobOutput, error) StartSentimentDetectionJobWithContext(aws.Context, *comprehend.StartSentimentDetectionJobInput, ...request.Option) (*comprehend.StartSentimentDetectionJobOutput, error) StartSentimentDetectionJobRequest(*comprehend.StartSentimentDetectionJobInput) (*request.Request, *comprehend.StartSentimentDetectionJobOutput) @@ -264,6 +280,10 @@ type ComprehendAPI interface { StopKeyPhrasesDetectionJobWithContext(aws.Context, *comprehend.StopKeyPhrasesDetectionJobInput, ...request.Option) (*comprehend.StopKeyPhrasesDetectionJobOutput, error) StopKeyPhrasesDetectionJobRequest(*comprehend.StopKeyPhrasesDetectionJobInput) (*request.Request, *comprehend.StopKeyPhrasesDetectionJobOutput) + StopPiiEntitiesDetectionJob(*comprehend.StopPiiEntitiesDetectionJobInput) (*comprehend.StopPiiEntitiesDetectionJobOutput, error) + StopPiiEntitiesDetectionJobWithContext(aws.Context, *comprehend.StopPiiEntitiesDetectionJobInput, ...request.Option) (*comprehend.StopPiiEntitiesDetectionJobOutput, error) + StopPiiEntitiesDetectionJobRequest(*comprehend.StopPiiEntitiesDetectionJobInput) (*request.Request, *comprehend.StopPiiEntitiesDetectionJobOutput) + StopSentimentDetectionJob(*comprehend.StopSentimentDetectionJobInput) (*comprehend.StopSentimentDetectionJobOutput, error) StopSentimentDetectionJobWithContext(aws.Context, *comprehend.StopSentimentDetectionJobInput, ...request.Option) (*comprehend.StopSentimentDetectionJobOutput, error) StopSentimentDetectionJobRequest(*comprehend.StopSentimentDetectionJobInput) (*request.Request, *comprehend.StopSentimentDetectionJobOutput) diff --git a/service/elasticsearchservice/api.go b/service/elasticsearchservice/api.go index 888f303cba..9511ad4892 100644 --- a/service/elasticsearchservice/api.go +++ b/service/elasticsearchservice/api.go @@ -11300,6 +11300,9 @@ func InboundCrossClusterSearchConnectionStatusCode_Values() []string { // * ES_APPLICATION_LOGS: Elasticsearch application logs contain information // about errors and warnings raised during the operation of the service and // can be useful for troubleshooting. +// +// * AUDIT_LOGS: Audit logs contain records of user requests for access from +// the domain. const ( // LogTypeIndexSlowLogs is a LogType enum value LogTypeIndexSlowLogs = "INDEX_SLOW_LOGS" @@ -11309,6 +11312,9 @@ const ( // LogTypeEsApplicationLogs is a LogType enum value LogTypeEsApplicationLogs = "ES_APPLICATION_LOGS" + + // LogTypeAuditLogs is a LogType enum value + LogTypeAuditLogs = "AUDIT_LOGS" ) // LogType_Values returns all elements of the LogType enum @@ -11317,6 +11323,7 @@ func LogType_Values() []string { LogTypeIndexSlowLogs, LogTypeSearchSlowLogs, LogTypeEsApplicationLogs, + LogTypeAuditLogs, } } diff --git a/service/kendra/api.go b/service/kendra/api.go index 6c352d3e58..60daff0831 100644 --- a/service/kendra/api.go +++ b/service/kendra/api.go @@ -252,12 +252,9 @@ func (c *Kendra) CreateDataSourceRequest(input *CreateDataSourceInput) (req *req // // Creates a data source that you use to with an Amazon Kendra index. // -// You specify a name, connector type and description for your data source. -// You can choose between an S3 connector, a SharePoint Online connector, and -// a database connector. -// -// You also specify configuration information such as document metadata (author, -// source URI, and so on) and user context information. +// You specify a name, data source connector type and description for your data +// source. You also specify configuration information such as document metadata +// (author, source URI, and so on) and user context information. // // CreateDataSource is a synchronous operation. The operation returns 200 if // the data source was successfully created. Otherwise, an exception is raised. @@ -3459,7 +3456,8 @@ func (s *ConnectionConfiguration) SetTableName(v string) *ConnectionConfiguratio type CreateDataSourceInput struct { _ struct{} `type:"structure"` - // The connector configuration information that is required to access the repository. + // The data source connector configuration information that is required to access + // the repository. // // Configuration is a required field Configuration *DataSourceConfiguration `type:"structure" required:"true"` @@ -3641,6 +3639,16 @@ type CreateFaqInput struct { // A description of the FAQ. Description *string `min:"1" type:"string"` + // The format of the input file. You can choose between a basic CSV format, + // a CSV format that includes customs attributes in a header, and a JSON format + // that includes custom attributes. + // + // The format must match the format of the file stored in the S3 bucket identified + // in the S3Path parameter. + // + // For more information, see Adding questions and answers (https://docs.aws.amazon.com/kendra/latest/dg/in-creating-faq.html). + FileFormat *string `type:"string" enum:"FaqFileFormat"` + // The identifier of the index that contains the FAQ. // // IndexId is a required field @@ -3733,6 +3741,12 @@ func (s *CreateFaqInput) SetDescription(v string) *CreateFaqInput { return s } +// SetFileFormat sets the FileFormat field's value. +func (s *CreateFaqInput) SetFileFormat(v string) *CreateFaqInput { + s.FileFormat = &v + return s +} + // SetIndexId sets the IndexId field's value. func (s *CreateFaqInput) SetIndexId(v string) *CreateFaqInput { s.IndexId = &v @@ -3950,14 +3964,14 @@ func (s *CreateIndexOutput) SetId(v string) *CreateIndexOutput { type DataSourceConfiguration struct { _ struct{} `type:"structure"` - // Provides information necessary to create a connector for a database. + // Provides information necessary to create a data source connector for a database. DatabaseConfiguration *DatabaseConfiguration `type:"structure"` // Provided configuration for data sources that connect to Microsoft OneDrive. OneDriveConfiguration *OneDriveConfiguration `type:"structure"` - // Provides information to create a connector for a document repository in an - // Amazon S3 bucket. + // Provides information to create a data source connector for a document repository + // in an Amazon S3 bucket. S3Configuration *S3DataSourceConfiguration `type:"structure"` // Provides configuration information for data sources that connect to a Salesforce @@ -3967,8 +3981,8 @@ type DataSourceConfiguration struct { // Provides configuration for data sources that connect to ServiceNow instances. ServiceNowConfiguration *ServiceNowConfiguration `type:"structure"` - // Provides information necessary to create a connector for a Microsoft SharePoint - // site. + // Provides information necessary to create a data source connector for a Microsoft + // SharePoint site. SharePointConfiguration *SharePointConfiguration `type:"structure"` } @@ -4152,7 +4166,7 @@ type DataSourceSyncJob struct { // Maps a batch delete document request to a specific data source sync job. // This is optional and should only be supplied when documents are deleted by - // a connector. + // a data source connector. Metrics *DataSourceSyncJobMetrics `type:"structure"` // The UNIX datetime that the synchronization job was started. @@ -4284,7 +4298,7 @@ func (s *DataSourceSyncJobMetricTarget) SetDataSourceSyncJobId(v string) *DataSo // Maps a batch delete document request to a specific data source sync job. // This is optional and should only be supplied when documents are deleted by -// a connector. +// a data source connector. type DataSourceSyncJobMetrics struct { _ struct{} `type:"structure"` @@ -5056,6 +5070,9 @@ type DescribeFaqOutput struct { // why the FAQ failed. ErrorMessage *string `min:"1" type:"string"` + // The file format used by the input files for the FAQ. + FileFormat *string `type:"string" enum:"FaqFileFormat"` + // The identifier of the FAQ. Id *string `min:"1" type:"string"` @@ -5107,6 +5124,12 @@ func (s *DescribeFaqOutput) SetErrorMessage(v string) *DescribeFaqOutput { return s } +// SetFileFormat sets the FileFormat field's value. +func (s *DescribeFaqOutput) SetFileFormat(v string) *DescribeFaqOutput { + s.FileFormat = &v + return s +} + // SetId sets the Id field's value. func (s *DescribeFaqOutput) SetId(v string) *DescribeFaqOutput { s.Id = &v @@ -5860,6 +5883,9 @@ type FaqSummary struct { // The UNIX datetime that the FAQ was added to the index. CreatedAt *time.Time `type:"timestamp"` + // The file type used to create the FAQ. + FileFormat *string `type:"string" enum:"FaqFileFormat"` + // The unique identifier of the FAQ. Id *string `min:"1" type:"string"` @@ -5890,6 +5916,12 @@ func (s *FaqSummary) SetCreatedAt(v time.Time) *FaqSummary { return s } +// SetFileFormat sets the FileFormat field's value. +func (s *FaqSummary) SetFileFormat(v string) *FaqSummary { + s.FileFormat = &v + return s +} + // SetId sets the Id field's value. func (s *FaqSummary) SetId(v string) *FaqSummary { s.Id = &v @@ -10404,6 +10436,26 @@ func ErrorCode_Values() []string { } } +const ( + // FaqFileFormatCsv is a FaqFileFormat enum value + FaqFileFormatCsv = "CSV" + + // FaqFileFormatCsvWithHeader is a FaqFileFormat enum value + FaqFileFormatCsvWithHeader = "CSV_WITH_HEADER" + + // FaqFileFormatJson is a FaqFileFormat enum value + FaqFileFormatJson = "JSON" +) + +// FaqFileFormat_Values returns all elements of the FaqFileFormat enum +func FaqFileFormat_Values() []string { + return []string{ + FaqFileFormatCsv, + FaqFileFormatCsvWithHeader, + FaqFileFormatJson, + } +} + const ( // FaqStatusCreating is a FaqStatus enum value FaqStatusCreating = "CREATING" diff --git a/service/transcribestreamingservice/api.go b/service/transcribestreamingservice/api.go index 29a77290cc..85318c6784 100644 --- a/service/transcribestreamingservice/api.go +++ b/service/transcribestreamingservice/api.go @@ -959,6 +959,13 @@ type Result struct { // contains one item that contains the result of the transcription. Alternatives []*Alternative `type:"list"` + // When channel identification is enabled, Amazon Transcribe transcribes the + // speech from each audio channel separately. + // + // You can use ChannelId to retrieve the transcription results for a single + // channel in your audio stream. + ChannelId *string `type:"string"` + // The offset in seconds from the beginning of the audio stream to the end of // the result. EndTime *float64 `type:"double"` @@ -995,6 +1002,12 @@ func (s *Result) SetAlternatives(v []*Alternative) *Result { return s } +// SetChannelId sets the ChannelId field's value. +func (s *Result) SetChannelId(v string) *Result { + s.ChannelId = &v + return s +} + // SetEndTime sets the EndTime field's value. func (s *Result) SetEndTime(v float64) *Result { s.EndTime = &v @@ -1107,6 +1120,16 @@ func (s *ServiceUnavailableException) RequestID() string { type StartStreamTranscriptionInput struct { _ struct{} `type:"structure" payload:"AudioStream"` + // When true, instructs Amazon Transcribe to process each audio channel separately + // and then merge the transcription output of each channel into a single transcription. + // + // Amazon Transcribe also produces a transcription of each item. An item includes + // the start time, end time, and any alternative transcriptions. + // + // You can't set both ShowSpeakerLabel and EnableChannelIdentification in the + // same request. If you set both, your request returns a BadRequestException. + EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` + // Indicates the source language used in the input audio stream. // // LanguageCode is a required field @@ -1123,10 +1146,13 @@ type StartStreamTranscriptionInput struct { // MediaSampleRateHertz is a required field MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer" required:"true"` + // The number of channels that are in your audio stream. + NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` + // A identifier for the transcription session. Use this parameter when you want // to retry a session. If you don't provide a session ID, Amazon Transcribe // will generate one for you and return it in the response. - SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" type:"string"` + SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` // When true, enables speaker identification in your real-time stream. ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` @@ -1171,6 +1197,12 @@ func (s *StartStreamTranscriptionInput) Validate() error { if s.MediaSampleRateHertz != nil && *s.MediaSampleRateHertz < 8000 { invalidParams.Add(request.NewErrParamMinValue("MediaSampleRateHertz", 8000)) } + if s.NumberOfChannels != nil && *s.NumberOfChannels < 2 { + invalidParams.Add(request.NewErrParamMinValue("NumberOfChannels", 2)) + } + if s.SessionId != nil && len(*s.SessionId) < 36 { + invalidParams.Add(request.NewErrParamMinLen("SessionId", 36)) + } if s.VocabularyFilterName != nil && len(*s.VocabularyFilterName) < 1 { invalidParams.Add(request.NewErrParamMinLen("VocabularyFilterName", 1)) } @@ -1184,6 +1216,12 @@ func (s *StartStreamTranscriptionInput) Validate() error { return nil } +// SetEnableChannelIdentification sets the EnableChannelIdentification field's value. +func (s *StartStreamTranscriptionInput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionInput { + s.EnableChannelIdentification = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *StartStreamTranscriptionInput) SetLanguageCode(v string) *StartStreamTranscriptionInput { s.LanguageCode = &v @@ -1202,6 +1240,12 @@ func (s *StartStreamTranscriptionInput) SetMediaSampleRateHertz(v int64) *StartS return s } +// SetNumberOfChannels sets the NumberOfChannels field's value. +func (s *StartStreamTranscriptionInput) SetNumberOfChannels(v int64) *StartStreamTranscriptionInput { + s.NumberOfChannels = &v + return s +} + // SetSessionId sets the SessionId field's value. func (s *StartStreamTranscriptionInput) SetSessionId(v string) *StartStreamTranscriptionInput { s.SessionId = &v @@ -1237,6 +1281,9 @@ type StartStreamTranscriptionOutput struct { eventStream *StartStreamTranscriptionEventStream + // Shows whether channel identification has been enabled in the stream. + EnableChannelIdentification *bool `location:"header" locationName:"x-amzn-transcribe-enable-channel-identification" type:"boolean"` + // The language code for the input audio stream. LanguageCode *string `location:"header" locationName:"x-amzn-transcribe-language-code" type:"string" enum:"LanguageCode"` @@ -1247,11 +1294,14 @@ type StartStreamTranscriptionOutput struct { // and 16000 Hz for high quality audio. MediaSampleRateHertz *int64 `location:"header" locationName:"x-amzn-transcribe-sample-rate" min:"8000" type:"integer"` + // The number of channels identified in the stream. + NumberOfChannels *int64 `location:"header" locationName:"x-amzn-transcribe-number-of-channels" min:"2" type:"integer"` + // An identifier for the streaming transcription. RequestId *string `location:"header" locationName:"x-amzn-request-id" type:"string"` // An identifier for a specific transcription session. - SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" type:"string"` + SessionId *string `location:"header" locationName:"x-amzn-transcribe-session-id" min:"36" type:"string"` // Shows whether speaker identification was enabled in the stream. ShowSpeakerLabel *bool `location:"header" locationName:"x-amzn-transcribe-show-speaker-label" type:"boolean"` @@ -1276,6 +1326,12 @@ func (s StartStreamTranscriptionOutput) GoString() string { return s.String() } +// SetEnableChannelIdentification sets the EnableChannelIdentification field's value. +func (s *StartStreamTranscriptionOutput) SetEnableChannelIdentification(v bool) *StartStreamTranscriptionOutput { + s.EnableChannelIdentification = &v + return s +} + // SetLanguageCode sets the LanguageCode field's value. func (s *StartStreamTranscriptionOutput) SetLanguageCode(v string) *StartStreamTranscriptionOutput { s.LanguageCode = &v @@ -1294,6 +1350,12 @@ func (s *StartStreamTranscriptionOutput) SetMediaSampleRateHertz(v int64) *Start return s } +// SetNumberOfChannels sets the NumberOfChannels field's value. +func (s *StartStreamTranscriptionOutput) SetNumberOfChannels(v int64) *StartStreamTranscriptionOutput { + s.NumberOfChannels = &v + return s +} + // SetRequestId sets the RequestId field's value. func (s *StartStreamTranscriptionOutput) SetRequestId(v string) *StartStreamTranscriptionOutput { s.RequestId = &v diff --git a/service/transcribestreamingservice/eventstream_test.go b/service/transcribestreamingservice/eventstream_test.go index b0c2534da5..daa92d0445 100644 --- a/service/transcribestreamingservice/eventstream_test.go +++ b/service/transcribestreamingservice/eventstream_test.go @@ -315,6 +315,7 @@ func mockStartStreamTranscriptionReadEvents() ( Transcript: aws.String("string value goes here"), }, }, + ChannelId: aws.String("string value goes here"), EndTime: aws.Float64(123.45), IsPartial: aws.Bool(true), ResultId: aws.String("string value goes here"), @@ -410,6 +411,7 @@ func mockStartStreamTranscriptionReadEvents() ( Transcript: aws.String("string value goes here"), }, }, + ChannelId: aws.String("string value goes here"), EndTime: aws.Float64(123.45), IsPartial: aws.Bool(true), ResultId: aws.String("string value goes here"), @@ -505,6 +507,7 @@ func mockStartStreamTranscriptionReadEvents() ( Transcript: aws.String("string value goes here"), }, }, + ChannelId: aws.String("string value goes here"), EndTime: aws.Float64(123.45), IsPartial: aws.Bool(true), ResultId: aws.String("string value goes here"),