aws-sdk-transcribeservice 1.35.0 → 1.36.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0a8b20d5eef067b6f52c6f7a52110c1e97f964a7
-  data.tar.gz: f9ca6eb895ecbb6ac8593e6465bc8bb4bbc90359
+  metadata.gz: 4372d838d4b919e3303c2f22a6fdde250f98da32
+  data.tar.gz: 15a44f2c12d5dd9e834958bbde9f4a14508f1747
 SHA512:
-  metadata.gz: 7c33a2e6113d4db050d1d632ad30655573525d297e3d6e605a4b344d357aaca2cb615dfd196de7171bbe47bb34c9417eb055fa996a236674f7cf1117cb0466be
-  data.tar.gz: 2e9731db2bc8871a297e5545340526054cd925982b80d04d92322dc5be1fbd42173e2bc6e7ee0c10517bedb139e979aafdb5c59cbf08634480fa596495234b1b
+  metadata.gz: '09f4a17d07fbe5cf7fd6a872d242d4ddca170ee0fafe79bfb412c12001d5b9ffff63886358f45e1d05dadad92083ec5cc6750dca800a8db8a4535dc389dcd5b3'
+  data.tar.gz: aa5540922928c160925f3ce848c70da36fb3dff48098daaa0ce33ff455a8c6acc921a6b580bb6634a15f00c9a0e11df1b791647994cc532f2ee46e012556c762

data/lib/aws-sdk-transcribeservice.rb

@@ -42,6 +42,6 @@ require_relative 'aws-sdk-transcribeservice/customizations'
 # @service
 module Aws::TranscribeService
 
-  GEM_VERSION = '1.35.0'
+  GEM_VERSION = '1.36.0'
 
 end

data/lib/aws-sdk-transcribeservice/client.rb

@@ -475,7 +475,9 @@ module Aws::TranscribeService
     # Returns information about a transcription job. To see the status of
     # the job, check the `TranscriptionJobStatus` field. If the status is
     # `COMPLETED`, the job is finished and you can find the results at the
-    # location specified in the `TranscriptionFileUri` field.
+    # location specified in the `TranscriptFileUri` field. If you enable
+    # content redaction, the redacted transcript appears in
+    # `RedactedTranscriptFileUri`.
     #
     # @option params [required, String] :transcription_job_name
     #   The name of the job.
@@ -499,6 +501,7 @@ module Aws::TranscribeService
     #   resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
     #   resp.transcription_job.media.media_file_uri #=> String
     #   resp.transcription_job.transcript.transcript_file_uri #=> String
+    #   resp.transcription_job.transcript.redacted_transcript_file_uri #=> String
     #   resp.transcription_job.start_time #=> Time
     #   resp.transcription_job.creation_time #=> Time
     #   resp.transcription_job.completion_time #=> Time
@@ -513,6 +516,8 @@ module Aws::TranscribeService
     #   resp.transcription_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask"
     #   resp.transcription_job.job_execution_settings.allow_deferred_execution #=> Boolean
     #   resp.transcription_job.job_execution_settings.data_access_role_arn #=> String
+    #   resp.transcription_job.content_redaction.redaction_type #=> String, one of "PII"
+    #   resp.transcription_job.content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/GetTranscriptionJob AWS API Documentation
     #
@@ -645,6 +650,8 @@ module Aws::TranscribeService
     #   resp.transcription_job_summaries[0].transcription_job_status #=> String, one of "QUEUED", "IN_PROGRESS", "FAILED", "COMPLETED"
     #   resp.transcription_job_summaries[0].failure_reason #=> String
     #   resp.transcription_job_summaries[0].output_location_type #=> String, one of "CUSTOMER_BUCKET", "SERVICE_BUCKET"
+    #   resp.transcription_job_summaries[0].content_redaction.redaction_type #=> String, one of "PII"
+    #   resp.transcription_job_summaries[0].content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ListTranscriptionJobs AWS API Documentation
     #
@@ -786,11 +793,15 @@ module Aws::TranscribeService
     #   The location where the transcription is stored.
     #
     #   If you set the `OutputBucketName`, Amazon Transcribe puts the
-    #   transcription in the specified S3 bucket. When you call the
+    #   transcript in the specified S3 bucket. When you call the
     #   GetTranscriptionJob operation, the operation returns this location in
-    #   the `TranscriptFileUri` field. The S3 bucket must have permissions
-    #   that allow Amazon Transcribe to put files in the bucket. For more
-    #   information, see [Permissions Required for IAM User Roles][1].
+    #   the `TranscriptFileUri` field. If you enable content redaction, the
+    #   redacted transcript appears in `RedactedTranscriptFileUri`. If you
+    #   enable content redaction and choose to output an unredacted
+    #   transcript, that transcript's location still appears in the
+    #   `TranscriptFileUri`. The S3 bucket must have permissions that allow
+    #   Amazon Transcribe to put files in the bucket. For more information,
+    #   see [Permissions Required for IAM User Roles][1].
     #
     #   You can specify an AWS Key Management Service (KMS) key to encrypt the
     #   output of your transcription using the `OutputEncryptionKMSKeyId`
@@ -847,6 +858,9 @@ module Aws::TranscribeService
     #   execution if the concurrency limit is reached and there are no slots
     #   available to immediately run the job.
     #
+    # @option params [Types::ContentRedaction] :content_redaction
+    #   An object that contains the request parameters for content redaction.
+    #
     # @return [Types::StartTranscriptionJobResponse] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
     #
     #   * {Types::StartTranscriptionJobResponse#transcription_job #transcription_job} => Types::TranscriptionJob
@@ -877,6 +891,10 @@ module Aws::TranscribeService
     #       allow_deferred_execution: false,
     #       data_access_role_arn: "DataAccessRoleArn",
     #     },
+    #     content_redaction: {
+    #       redaction_type: "PII", # required, accepts PII
+    #       redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
+    #     },
     #   })
     #
     # @example Response structure
@@ -888,6 +906,7 @@ module Aws::TranscribeService
     #   resp.transcription_job.media_format #=> String, one of "mp3", "mp4", "wav", "flac"
     #   resp.transcription_job.media.media_file_uri #=> String
     #   resp.transcription_job.transcript.transcript_file_uri #=> String
+    #   resp.transcription_job.transcript.redacted_transcript_file_uri #=> String
     #   resp.transcription_job.start_time #=> Time
     #   resp.transcription_job.creation_time #=> Time
     #   resp.transcription_job.completion_time #=> Time
@@ -902,6 +921,8 @@ module Aws::TranscribeService
     #   resp.transcription_job.settings.vocabulary_filter_method #=> String, one of "remove", "mask"
     #   resp.transcription_job.job_execution_settings.allow_deferred_execution #=> Boolean
     #   resp.transcription_job.job_execution_settings.data_access_role_arn #=> String
+    #   resp.transcription_job.content_redaction.redaction_type #=> String, one of "PII"
+    #   resp.transcription_job.content_redaction.redaction_output #=> String, one of "redacted", "redacted_and_unredacted"
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJob AWS API Documentation
     #
@@ -1056,7 +1077,7 @@ module Aws::TranscribeService
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-transcribeservice'
-      context[:gem_version] = '1.35.0'
+      context[:gem_version] = '1.36.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

data/lib/aws-sdk-transcribeservice/client_api.rb

@@ -14,6 +14,7 @@ module Aws::TranscribeService
     BadRequestException = Shapes::StructureShape.new(name: 'BadRequestException')
     Boolean = Shapes::BooleanShape.new(name: 'Boolean')
     ConflictException = Shapes::StructureShape.new(name: 'ConflictException')
+    ContentRedaction = Shapes::StructureShape.new(name: 'ContentRedaction')
     CreateVocabularyFilterRequest = Shapes::StructureShape.new(name: 'CreateVocabularyFilterRequest')
     CreateVocabularyFilterResponse = Shapes::StructureShape.new(name: 'CreateVocabularyFilterResponse')
     CreateVocabularyRequest = Shapes::StructureShape.new(name: 'CreateVocabularyRequest')
@@ -53,6 +54,8 @@ module Aws::TranscribeService
     OutputLocationType = Shapes::StringShape.new(name: 'OutputLocationType')
     Phrase = Shapes::StringShape.new(name: 'Phrase')
     Phrases = Shapes::ListShape.new(name: 'Phrases')
+    RedactionOutput = Shapes::StringShape.new(name: 'RedactionOutput')
+    RedactionType = Shapes::StringShape.new(name: 'RedactionType')
     Settings = Shapes::StructureShape.new(name: 'Settings')
     StartTranscriptionJobRequest = Shapes::StructureShape.new(name: 'StartTranscriptionJobRequest')
     StartTranscriptionJobResponse = Shapes::StructureShape.new(name: 'StartTranscriptionJobResponse')
@@ -85,6 +88,10 @@ module Aws::TranscribeService
     ConflictException.add_member(:message, Shapes::ShapeRef.new(shape: String, location_name: "Message"))
     ConflictException.struct_class = Types::ConflictException
 
+    ContentRedaction.add_member(:redaction_type, Shapes::ShapeRef.new(shape: RedactionType, required: true, location_name: "RedactionType"))
+    ContentRedaction.add_member(:redaction_output, Shapes::ShapeRef.new(shape: RedactionOutput, required: true, location_name: "RedactionOutput"))
+    ContentRedaction.struct_class = Types::ContentRedaction
+
     CreateVocabularyFilterRequest.add_member(:vocabulary_filter_name, Shapes::ShapeRef.new(shape: VocabularyFilterName, required: true, location_name: "VocabularyFilterName"))
     CreateVocabularyFilterRequest.add_member(:language_code, Shapes::ShapeRef.new(shape: LanguageCode, required: true, location_name: "LanguageCode"))
     CreateVocabularyFilterRequest.add_member(:words, Shapes::ShapeRef.new(shape: Words, location_name: "Words"))
@@ -212,12 +219,14 @@ module Aws::TranscribeService
     StartTranscriptionJobRequest.add_member(:output_encryption_kms_key_id, Shapes::ShapeRef.new(shape: KMSKeyId, location_name: "OutputEncryptionKMSKeyId"))
     StartTranscriptionJobRequest.add_member(:settings, Shapes::ShapeRef.new(shape: Settings, location_name: "Settings"))
     StartTranscriptionJobRequest.add_member(:job_execution_settings, Shapes::ShapeRef.new(shape: JobExecutionSettings, location_name: "JobExecutionSettings"))
+    StartTranscriptionJobRequest.add_member(:content_redaction, Shapes::ShapeRef.new(shape: ContentRedaction, location_name: "ContentRedaction"))
     StartTranscriptionJobRequest.struct_class = Types::StartTranscriptionJobRequest
 
     StartTranscriptionJobResponse.add_member(:transcription_job, Shapes::ShapeRef.new(shape: TranscriptionJob, location_name: "TranscriptionJob"))
     StartTranscriptionJobResponse.struct_class = Types::StartTranscriptionJobResponse
 
     Transcript.add_member(:transcript_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "TranscriptFileUri"))
+    Transcript.add_member(:redacted_transcript_file_uri, Shapes::ShapeRef.new(shape: Uri, location_name: "RedactedTranscriptFileUri"))
     Transcript.struct_class = Types::Transcript
 
     TranscriptionJob.add_member(:transcription_job_name, Shapes::ShapeRef.new(shape: TranscriptionJobName, location_name: "TranscriptionJobName"))
@@ -233,6 +242,7 @@ module Aws::TranscribeService
     TranscriptionJob.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
     TranscriptionJob.add_member(:settings, Shapes::ShapeRef.new(shape: Settings, location_name: "Settings"))
     TranscriptionJob.add_member(:job_execution_settings, Shapes::ShapeRef.new(shape: JobExecutionSettings, location_name: "JobExecutionSettings"))
+    TranscriptionJob.add_member(:content_redaction, Shapes::ShapeRef.new(shape: ContentRedaction, location_name: "ContentRedaction"))
     TranscriptionJob.struct_class = Types::TranscriptionJob
 
     TranscriptionJobSummaries.member = Shapes::ShapeRef.new(shape: TranscriptionJobSummary)
@@ -245,6 +255,7 @@ module Aws::TranscribeService
     TranscriptionJobSummary.add_member(:transcription_job_status, Shapes::ShapeRef.new(shape: TranscriptionJobStatus, location_name: "TranscriptionJobStatus"))
     TranscriptionJobSummary.add_member(:failure_reason, Shapes::ShapeRef.new(shape: FailureReason, location_name: "FailureReason"))
     TranscriptionJobSummary.add_member(:output_location_type, Shapes::ShapeRef.new(shape: OutputLocationType, location_name: "OutputLocationType"))
+    TranscriptionJobSummary.add_member(:content_redaction, Shapes::ShapeRef.new(shape: ContentRedaction, location_name: "ContentRedaction"))
     TranscriptionJobSummary.struct_class = Types::TranscriptionJobSummary
 
     UpdateVocabularyFilterRequest.add_member(:vocabulary_filter_name, Shapes::ShapeRef.new(shape: VocabularyFilterName, required: true, location_name: "VocabularyFilterName"))

data/lib/aws-sdk-transcribeservice/types.rb

@@ -40,6 +40,48 @@ module Aws::TranscribeService
       include Aws::Structure
     end
 
+    # Settings for content redaction within a transcription job.
+    #
+    # You can redact transcripts in US English (en-us). For more information
+    # see: [Automatic Content Redaction][1]
+    #
+    #
+    #
+    # [1]: https://docs.aws.amazon.com/transcribe/latest/dg/content-redaction.html
+    #
+    # @note When making an API call, you may pass ContentRedaction
+    #   data as a hash:
+    #
+    #       {
+    #         redaction_type: "PII", # required, accepts PII
+    #         redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
+    #       }
+    #
+    # @!attribute [rw] redaction_type
+    #   Request parameter that defines the entities to be redacted. The only
+    #   accepted value is `PII`.
+    #   @return [String]
+    #
+    # @!attribute [rw] redaction_output
+    #   Request parameter where you choose whether to output only the
+    #   redacted transcript or generate an additional unredacted transcript.
+    #
+    #   When you choose `redacted` Amazon Transcribe outputs a JSON file
+    #   with only the redacted transcript and related information.
+    #
+    #   When you choose `redacted_and_unredacted` Amazon Transcribe outputs
+    #   a JSON file with the unredacted transcript and related information
+    #   in addition to the JSON file with the redacted transcript.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/ContentRedaction AWS API Documentation
+    #
+    class ContentRedaction < Struct.new(
+      :redaction_type,
+      :redaction_output)
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass CreateVocabularyFilterRequest
     #   data as a hash:
     #
@@ -680,19 +722,17 @@ module Aws::TranscribeService
     #       }
     #
     # @!attribute [rw] media_file_uri
-    #   The S3 location of the input media file. The URI must be in the same
-    #   region as the API endpoint that you are calling. The general form
-    #   is:
+    #   The S3 object location of the input media file. The URI must be in
+    #   the same region as the API endpoint that you are calling. The
+    #   general form is:
     #
-    #   `
-    #   https://s3.<aws-region>.amazonaws.com/<bucket-name>/<keyprefix>/<objectkey>
-    #   `
+    #   ` s3://<bucket-name>/<keyprefix>/<objectkey> `
     #
     #   For example:
     #
-    #   `https://s3.us-east-1.amazonaws.com/examplebucket/example.mp4`
+    #   `s3://examplebucket/example.mp4`
     #
-    #   `https://s3.us-east-1.amazonaws.com/examplebucket/mediadocs/example.mp4`
+    #   `s3://examplebucket/mediadocs/example.mp4`
     #
     #   For more information about S3 object names, see [Object Keys][1] in
     #   the *Amazon S3 Developer Guide*.
@@ -845,6 +885,10 @@ module Aws::TranscribeService
     #           allow_deferred_execution: false,
     #           data_access_role_arn: "DataAccessRoleArn",
     #         },
+    #         content_redaction: {
+    #           redaction_type: "PII", # required, accepts PII
+    #           redaction_output: "redacted", # required, accepts redacted, redacted_and_unredacted
+    #         },
     #       }
     #
     # @!attribute [rw] transcription_job_name
@@ -880,12 +924,15 @@ module Aws::TranscribeService
     #   The location where the transcription is stored.
     #
     #   If you set the `OutputBucketName`, Amazon Transcribe puts the
-    #   transcription in the specified S3 bucket. When you call the
+    #   transcript in the specified S3 bucket. When you call the
     #   GetTranscriptionJob operation, the operation returns this location
-    #   in the `TranscriptFileUri` field. The S3 bucket must have
-    #   permissions that allow Amazon Transcribe to put files in the bucket.
-    #   For more information, see [Permissions Required for IAM User
-    #   Roles][1].
+    #   in the `TranscriptFileUri` field. If you enable content redaction,
+    #   the redacted transcript appears in `RedactedTranscriptFileUri`. If
+    #   you enable content redaction and choose to output an unredacted
+    #   transcript, that transcript's location still appears in the
+    #   `TranscriptFileUri`. The S3 bucket must have permissions that allow
+    #   Amazon Transcribe to put files in the bucket. For more information,
+    #   see [Permissions Required for IAM User Roles][1].
     #
     #   You can specify an AWS Key Management Service (KMS) key to encrypt
     #   the output of your transcription using the
@@ -948,6 +995,11 @@ module Aws::TranscribeService
     #   available to immediately run the job.
     #   @return [Types::JobExecutionSettings]
     #
+    # @!attribute [rw] content_redaction
+    #   An object that contains the request parameters for content
+    #   redaction.
+    #   @return [Types::ContentRedaction]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/StartTranscriptionJobRequest AWS API Documentation
     #
     class StartTranscriptionJobRequest < Struct.new(
@@ -959,7 +1011,8 @@ module Aws::TranscribeService
       :output_bucket_name,
       :output_encryption_kms_key_id,
       :settings,
-      :job_execution_settings)
+      :job_execution_settings,
+      :content_redaction)
       include Aws::Structure
     end
 
@@ -977,19 +1030,30 @@ module Aws::TranscribeService
     # Identifies the location of a transcription.
     #
     # @!attribute [rw] transcript_file_uri
-    #   The location where the transcription is stored.
+    #   The S3 object location of the the transcript.
+    #
+    #   Use this URI to access the transcript. If you specified an S3 bucket
+    #   in the `OutputBucketName` field when you created the job, this is
+    #   the URI of that bucket. If you chose to store the transcript in
+    #   Amazon Transcribe, this is a shareable URL that provides secure
+    #   access to that location.
+    #   @return [String]
     #
-    #   Use this URI to access the transcription. If you specified an S3
-    #   bucket in the `OutputBucketName` field when you created the job,
-    #   this is the URI of that bucket. If you chose to store the
-    #   transcription in Amazon Transcribe, this is a shareable URL that
-    #   provides secure access to that location.
+    # @!attribute [rw] redacted_transcript_file_uri
+    #   The S3 object location of the redacted transcript.
+    #
+    #   Use this URI to access the redacated transcript. If you specified an
+    #   S3 bucket in the `OutputBucketName` field when you created the job,
+    #   this is the URI of that bucket. If you chose to store the transcript
+    #   in Amazon Transcribe, this is a shareable URL that provides secure
+    #   access to that location.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/Transcript AWS API Documentation
     #
     class Transcript < Struct.new(
-      :transcript_file_uri)
+      :transcript_file_uri,
+      :redacted_transcript_file_uri)
       include Aws::Structure
     end
 
@@ -1090,6 +1154,11 @@ module Aws::TranscribeService
     #   Provides information about how a transcription job is executed.
     #   @return [Types::JobExecutionSettings]
     #
+    # @!attribute [rw] content_redaction
+    #   An object that describes content redaction settings for the
+    #   transcription job.
+    #   @return [Types::ContentRedaction]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJob AWS API Documentation
     #
     class TranscriptionJob < Struct.new(
@@ -1105,7 +1174,8 @@ module Aws::TranscribeService
       :completion_time,
       :failure_reason,
       :settings,
-      :job_execution_settings)
+      :job_execution_settings,
+      :content_redaction)
       include Aws::Structure
     end
 
@@ -1154,6 +1224,10 @@ module Aws::TranscribeService
     #   `GetTranscriptionJob` response's `TranscriptFileUri` field.
     #   @return [String]
     #
+    # @!attribute [rw] content_redaction
+    #   The content redaction settings of the transcription job.
+    #   @return [Types::ContentRedaction]
+    #
     # @see http://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/TranscriptionJobSummary AWS API Documentation
     #
     class TranscriptionJobSummary < Struct.new(
@@ -1164,7 +1238,8 @@ module Aws::TranscribeService
       :language_code,
       :transcription_job_status,
       :failure_reason,
-      :output_location_type)
+      :output_location_type,
+      :content_redaction)
       include Aws::Structure
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-transcribeservice
 version: !ruby/object:Gem::Version
-  version: 1.35.0
+  version: 1.36.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-12-20 00:00:00.000000000 Z
+date: 2020-02-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core