:doc:`TranscribeService <../../transcribe>` / Client / create_vocabulary_filter

************************
create_vocabulary_filter
************************



.. py:method:: TranscribeService.Client.create_vocabulary_filter(**kwargs)

  

  Creates a new custom vocabulary filter.

   

  You can use custom vocabulary filters to mask, delete, or flag specific words from your transcript. Custom vocabulary filters are commonly used to mask profanity in transcripts.

   

  Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to `Character Sets for Custom Vocabularies <https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html>`__ to get the character set for your language.

   

  For more information, see `Vocabulary filtering <https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/transcribe-2017-10-26/CreateVocabularyFilter>`_  


  **Request Syntax**
  ::

    response = client.create_vocabulary_filter(
        VocabularyFilterName='string',
        LanguageCode='af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-EE'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zh-HK'|'zu-ZA',
        Words=[
            'string',
        ],
        VocabularyFilterFileUri='string',
        Tags=[
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        DataAccessRoleArn='string'
    )
    
  :type VocabularyFilterName: string
  :param VocabularyFilterName: **[REQUIRED]** 

    A unique name, chosen by you, for your new custom vocabulary filter.

     

    This name is case sensitive, cannot contain spaces, and must be unique within an Amazon Web Services account. If you try to create a new custom vocabulary filter with the same name as an existing custom vocabulary filter, you get a ``ConflictException`` error.

    

  
  :type LanguageCode: string
  :param LanguageCode: **[REQUIRED]** 

    The language code that represents the language of the entries in your vocabulary filter. Each custom vocabulary filter must contain terms in only one language.

     

    A custom vocabulary filter can only be used to transcribe files in the same language as the filter. For example, if you create a custom vocabulary filter using US English ( ``en-US``), you can only apply this filter to files that contain English audio.

     

    For a list of supported languages and their associated language codes, refer to the `Supported languages <https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html>`__ table.

    

  
  :type Words: list
  :param Words: 

    Use this parameter if you want to create your custom vocabulary filter by including all desired terms, as comma-separated values, within your request. The other option for creating your vocabulary filter is to save your entries in a text file and upload them to an Amazon S3 bucket, then specify the location of your file using the ``VocabularyFilterFileUri`` parameter.

     

    Note that if you include ``Words`` in your request, you cannot use ``VocabularyFilterFileUri``; you must choose one or the other.

     

    Each language has a character set that contains all allowed characters for that specific language. If you use unsupported characters, your custom vocabulary filter request fails. Refer to `Character Sets for Custom Vocabularies <https://docs.aws.amazon.com/transcribe/latest/dg/charsets.html>`__ to get the character set for your language.

    

  
    - *(string) --* 

    

  :type VocabularyFilterFileUri: string
  :param VocabularyFilterFileUri: 

    The Amazon S3 location of the text file that contains your custom vocabulary filter terms. The URI must be located in the same Amazon Web Services Region as the resource you're calling.

     

    Here's an example URI path: ``s3://DOC-EXAMPLE-BUCKET/my-vocab-filter-file.txt``

     

    Note that if you include ``VocabularyFilterFileUri`` in your request, you cannot use ``Words``; you must choose one or the other.

    

  
  :type Tags: list
  :param Tags: 

    Adds one or more custom tags, each in the form of a key:value pair, to a new custom vocabulary filter at the time you create this new vocabulary filter.

     

    To learn more about using tags with Amazon Transcribe, refer to `Tagging resources <https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html>`__.

    

  
    - *(dict) --* 

      Adds metadata, in the form of a key:value pair, to the specified resource.

       

      For example, you could add the tag ``Department:Sales`` to a resource to indicate that it pertains to your organization's sales department. You can also use tags for tag-based access control.

       

      To learn more about tagging, see `Tagging resources <https://docs.aws.amazon.com/transcribe/latest/dg/tagging.html>`__.

      

    
      - **Key** *(string) --* **[REQUIRED]** 

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

        

      
      - **Value** *(string) --* **[REQUIRED]** 

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

         

        Note that you can set the value of a tag to an empty string, but you can't set the value of a tag to null. Omitting the tag value is the same as using an empty string.

        

      
    

  :type DataAccessRoleArn: string
  :param DataAccessRoleArn: 

    The Amazon Resource Name (ARN) of an IAM role that has permissions to access the Amazon S3 bucket that contains your input files (in this case, your custom vocabulary filter). If the role that you specify doesn’t have the appropriate permissions to access the specified Amazon S3 location, your request fails.

     

    IAM role ARNs have the format ``arn:partition:iam::account:role/role-name-with-path``. For example: ``arn:aws:iam::111122223333:role/Admin``.

     

    For more information, see `IAM ARNs <https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns>`__.

    

  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {
          'VocabularyFilterName': 'string',
          'LanguageCode': 'af-ZA'|'ar-AE'|'ar-SA'|'da-DK'|'de-CH'|'de-DE'|'en-AB'|'en-AU'|'en-GB'|'en-IE'|'en-IN'|'en-US'|'en-WL'|'es-ES'|'es-US'|'fa-IR'|'fr-CA'|'fr-FR'|'he-IL'|'hi-IN'|'id-ID'|'it-IT'|'ja-JP'|'ko-KR'|'ms-MY'|'nl-NL'|'pt-BR'|'pt-PT'|'ru-RU'|'ta-IN'|'te-IN'|'tr-TR'|'zh-CN'|'zh-TW'|'th-TH'|'en-ZA'|'en-NZ'|'vi-VN'|'sv-SE'|'ab-GE'|'ast-ES'|'az-AZ'|'ba-RU'|'be-BY'|'bg-BG'|'bn-IN'|'bs-BA'|'ca-ES'|'ckb-IQ'|'ckb-IR'|'cs-CZ'|'cy-WL'|'el-GR'|'et-EE'|'et-ET'|'eu-ES'|'fi-FI'|'gl-ES'|'gu-IN'|'ha-NG'|'hr-HR'|'hu-HU'|'hy-AM'|'is-IS'|'ka-GE'|'kab-DZ'|'kk-KZ'|'kn-IN'|'ky-KG'|'lg-IN'|'lt-LT'|'lv-LV'|'mhr-RU'|'mi-NZ'|'mk-MK'|'ml-IN'|'mn-MN'|'mr-IN'|'mt-MT'|'no-NO'|'or-IN'|'pa-IN'|'pl-PL'|'ps-AF'|'ro-RO'|'rw-RW'|'si-LK'|'sk-SK'|'sl-SI'|'so-SO'|'sr-RS'|'su-ID'|'sw-BI'|'sw-KE'|'sw-RW'|'sw-TZ'|'sw-UG'|'tl-PH'|'tt-RU'|'ug-CN'|'uk-UA'|'uz-UZ'|'wo-SN'|'zh-HK'|'zu-ZA',
          'LastModifiedTime': datetime(2015, 1, 1)
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **VocabularyFilterName** *(string) --* 

        The name you chose for your custom vocabulary filter.

        
      

      - **LanguageCode** *(string) --* 

        The language code you selected for your custom vocabulary filter.

        
      

      - **LastModifiedTime** *(datetime) --* 

        The date and time you created your custom vocabulary filter.

         

        Timestamps are in the format ``YYYY-MM-DD'T'HH:MM:SS.SSSSSS-UTC``. For example, ``2022-05-04T12:32:58.761000-07:00`` represents 12:32 PM UTC-7 on May 4, 2022.

        
  
  **Exceptions**
  
  *   :py:class:`TranscribeService.Client.exceptions.BadRequestException`

  
  *   :py:class:`TranscribeService.Client.exceptions.LimitExceededException`

  
  *   :py:class:`TranscribeService.Client.exceptions.InternalFailureException`

  
  *   :py:class:`TranscribeService.Client.exceptions.ConflictException`

  