[日本語訳] AWS Amazon Polly 開発者ガイド APIリファレンス_其の２: DataTypes

これは・・・
`AWS > ドキュメント > Amazon Polly > 開発者ガイド`
の`APIリファレンス`より下層(Action,DataTypes)が日本語になってなくて読みにくいのでgoogle翻訳にコピペして日本語化したものをテキストエディタにコピペする代わりにココに書いたものです。
![aws_polly_API_Reference_1.jpg](https://blog-imgs-137.fc2.com/g/t/r/gtrinthesky/aws_polly_API_Reference_1.jpg "APIリファレンス部分ハイライト")
※場合によっては英単語のままにしてるヶ所もあります
※各章の最後にある"See Also" は省略
※「パターン」は(正規表現による)使える文字列
※「〜を参照してください」みたいなヶ所のリンクは無し
※文章の整形としてインデント(字下げ)代わりにMarkdownの"引用"を使用
※<font color=green>この色の文章は補足メモなどの追加</font>で、元記事や翻訳後にあるものではないです
![aws_polly_API_ref.jpg](https://blog-imgs-137.fc2.com/g/t/r/gtrinthesky/aws_polly_ref.jpg "比較")
- - -
関連項目メニュー代わり

- [APIリファレンス > Action 以下](https://qiita.com/Reng/items/73ed6a2878ee562e283d)
- APIリファレンス > DataTypes  以下 ←※いまココ

# APIリファレンス - Data Types

次のデータ型がサポートされています:
<font color=green>ここではメニュー代わりにページ内リンクです</font>
- [Lexicon](https://qiita.com/Reng/items/d92d6d4e3864951b463b#lexicon)
- [LexiconAttributes](https://qiita.com/Reng/items/d92d6d4e3864951b463b#lexiconattributes)
- [LexiconDescription](https://qiita.com/Reng/items/d92d6d4e3864951b463b#lexicondescription)
- [SynthesisTask](https://qiita.com/Reng/items/d92d6d4e3864951b463b#synthesistask)
- [Voice](https://qiita.com/Reng/items/d92d6d4e3864951b463b#voice)

> https://docs.aws.amazon.com/ja_jp/polly/latest/dg/API_Types.html

- - -
- - - 
## Lexicon
> https://docs.aws.amazon.com/ja_jp/polly/latest/dg/API_Lexicon.html

レキシコン名とレキシコンコンテンツを文字列形式で提供します。 詳細については、"Pronunciation Lexicon Specification (PLS) Version 1.0"を参照してください。

- - -
### Contents
__Content__
> 文字列形式のレキシコンコンテンツ。 レキシコンの内容はPLS形式である必要があります。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__Name__
> レキシコンの名前。
> 
> type：文字列
> 
> パターン：`[0-9A-Za-z]{1,20}`
> 
> 必須かどうか：必須ではない

- - - 
- - - 
## LexiconAttributes
> https://docs.aws.amazon.com/ja_jp/polly/latest/dg/API_LexiconAttributes.html

語彙素の数、言語コードなど、レキシコンを説明するメタデータが含まれています。 詳細については、レキシコンの管理を参照してください。
- - -
### Contents
__Alphabet__
> レキシコンで使用されるフォネティックコード。 有効な値は`ipa`と`x-sampa`です。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__LanguageCode__
> レキシコンが適用される言語コード。 「en」などの言語コードを持つレキシコンは、すべての英語言語（en-GB、en-US、en-AUS、en-WLSなど）に適用されます。
> 
> type：文字列
> 
> 有効な値：`arb | cmn-CN | cy-GB | da-DK | de-DE | en-AU | en-GB | en-GB-WLS | en-IN | en-US | es-ES | es-MX | es-US | fr-CA | fr-FR | is-IS | it-IT | ja-JP | hi-IN | ko-KR | nb-NO | nl-NL | pl-PL | pt-BR | pt-PT | ro-RO | ru-RU | sv-SE | tr-TR`
> 
> 必須かどうか：必須ではない

__LastModified__
> レキシコンが最後に変更された日付（タイムスタンプ値）。
> 
> type：タイムスタンプ
> 
> 必須かどうか：必須ではない

__LexemesCount__
> レキシコン内の語彙素の数。
> 
> type：整数
> 
> 必須かどうか：必須ではない

__LexiconArn__
> レキシコンのAmazonリソース名（ARN）。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__Size__
> レキシコンの合計サイズ（文字数）。
> 
> type：整数
> 
> 必須かどうか：必須ではない

- - -
- - - 
## LexiconDescription
>https://docs.aws.amazon.com/ja_jp/polly/latest/dg/API_LexiconDescription.html

レキシコンの内容について説明します。
- - -
### Contents
__Attributes__
> レキシコンメタデータを提供します。
> 
> type：LexiconAttributesオブジェクト
> 
> 必須かどうか：必須ではない

__Name__
> レキシコンの名前。
> 
> type：文字列
> 
> パターン：`[0-9A-Za-z]{1,20}`
> 
> 必須かどうか：必須ではない

- - - 
- - - 
## SynthesisTask
> https://docs.aws.amazon.com/ja_jp/polly/latest/dg/API_SynthesisTask.html

音声合成タスクに関する情報を提供するSynthesisTaskオブジェクト。
- - -
### Contents

__CreationTime__
> 合成タスクが開始された時刻のタイムスタンプ。
> 
> type：タイムスタンプ
> 
> 必須かどうか：必須ではない

__Engine__
> 音声合成の入力テキストを処理するときに使用するAmazonPollyのエンジン（標準またはニューラル）を指定します。選択したエンジンでサポートされていない音声を使用すると、エラーが発生します。
> 
> type：文字列

> 有効な値：`standard | neural`
> 
> 必須かどうか：必須ではない

__LanguageCode__
> 合成タスク用のオプションの言語コード。これは、インド英語（en-IN）またはヒンディー語（hi-IN）のいずれかに使用できるAditiなどのバイリンガル音声を使用する場合にのみ必要です。
> 
> バイリンガル音声が使用され、言語コードが指定されていない場合、AmazonPollyはバイリンガル音声のデフォルト言語を使用します。音声のデフォルト言語は、LanguageCodeパラメーターのDescribeVoices操作によって返される言語です。たとえば、言語コードが指定されていない場合、Aditiはヒンディー語ではなくインド英語を使用します。
> 
> type：文字列
> 
> 有効な値：`arb | cmn-CN | cy-GB | da-DK | de-DE | en-AU | en-GB | en-GB-WLS | en-IN | en-US | es-ES | es-MX | es-US | fr-CA | fr-FR | is-IS | it-IT | ja-JP | hi-IN | ko-KR | nb-NO | nl-NL | pl-PL | pt-BR | pt-PT | ro-RO | ru-RU | sv-SE | tr-TR
`
> 
> 必須かどうか：必須ではない

__LexiconNames__
> 合成中にサービスに適用する1つ以上の発音レキシコン名のリスト。レキシコンは、レキシコンの言語が音声の言語と同じである場合にのみ適用されます。
> 
> type：文字列の配列
> 
> 配列メンバー：最大5アイテム。

> パターン：`[0-9A-Za-z]{1,20}`
> 
> 必須かどうか：必須ではない

__OutputFormat__
> 返される出力がエンコードされる形式。 オーディオストリームの場合、これはmp3、ogg_vorbis、またはpcmになります。 スピーチマークの場合、これはjsonになります。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__OutputUri__
> 出力音声ファイルの経路。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__RequestCharacters__
> 合成された請求可能な文字の数。
> 
> type：整数
> 
> 必須かどうか：必須ではない



__SampleRate__
> Hzで指定された可聴周波数。
> 
> mp3とogg_vorbisの有効な値は、「8000」、「16000」、「22050」、および「24000」です。標準音声のデフォルト値は「22050」です。ニューラルボイスのデフォルト値は「24000」です。
> 
> pcmの有効な値は「8000」と「16000」。デフォルト値は「16000」。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__SnsTopicArn__
> 音声合成タスクのステータス通知を提供するためにオプションで使用されるSNSトピックのARN。
> 
> type：文字列
> 
> パターン：`^arn:aws(-(cn|iso(-b)?|us-gov))?:sns:[a-z0-9_-]{1,50}:\d{12}:[a-zA-Z0-9_-]{1,256}$`
> 
> 必須かどうか：必須ではない

__SpeechMarkTypes__
> 入力テキストに対して返されるスピーチマークのタイプ。
> 
> type：文字列の配列
> 
> 配列メンバー：最大4アイテム。
> 
> 有効な値：`sentence | ssml | viseme | word`
> 
> 必須かどうか：必須ではない

__TaskId__
> Amazon Pollyは、音声合成タスクの識別子を生成しました。
> 
> type：文字列
> 
> パターン：`^[a-zA-Z0-9_-]{1,100}$`
> 
> 必須かどうか：必須ではない

__TaskStatusReason__
> タスクが失敗した場合のエラーを含む、特定の音声合成タスクの現在のステータスの理由。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

__TextType__
> 入力テキストがプレーンテキストかSSMLかを指定します。デフォルト値はプレーンテキストです。
> 
> type：文字列
> 
> 有効な値：` ssml | text`
> 
> 必須かどうか：必須ではない

__VoiceId__
> 合成に使用する音声ID。
> 
> type：文字列
> 
> 有効な値：`Aditi | Amy | Astrid | Bianca | Brian | Camila | Carla | Carmen | Celine | Chantal | Conchita | Cristiano | Dora | Emma | Enrique | Ewa | Filiz | Geraint | Giorgio | Gwyneth | Hans | Ines | Ivy | Jacek | Jan | Joanna | Joey | Justin | Karl | Kendra | Kevin | Kimberly | Lea | Liv | Lotte | Lucia | Lupe | Mads | Maja | Marlene | Mathieu | Matthew | Maxim | Mia | Miguel | Mizuki | Naja | Nicole | Penelope | Raveena | Ricardo | Ruben | Russell | Salli | Seoyeon | Takumi | Tatyana | Vicki | Vitoria | Zeina | Zhiyu
`
> 
> 必須かどうか：必須ではない

- - - 
- - - 
## Voice

### Contents
__AdditionalLanguageCodes__
> デフォルトの言語に加えて、指定された音声で使用可能な言語の追加コード。
> 
> たとえば、Aditiのデフォルト言語は、その言語で最初に使用されたため、インド英語（en-IN）です。 Aditiはインド英語とヒンディー語の両方でバイリンガルで流暢であるため、このパラメーターはコードhi-INを表示します。
> 
> type：文字列の配列
> 
> 有効な値：`arb | cmn-CN | cy-GB | da-DK | de-DE | en-AU | en-GB | en-GB-WLS | en-IN | en-US | es-ES | es-MX | es-US | fr-CA | fr-FR | is-IS | it-IT | ja-JP | hi-IN | ko-KR | nb-NO | nl-NL | pl-PL | pt-BR | pt-PT | ro-RO | ru-RU | sv-SE | tr-TR`
> 
> 必須かどうか：必須ではない

__Gender__
> 声の性別。
> 
> type：文字列
> 
> 有効な値：`Female | Mal`
> 
> 必須かどうか：必須ではない

__Id__
> AmazonPollyが割り当てる音声ID。これは、SynthesizeSpeech操作を呼び出すときに指定するIDです。
> 
> type：文字列
> 
> 有効な値：`Aditi | Amy | Astrid | Bianca | Brian | Camila | Carla | Carmen | Celine | Chantal | Conchita | Cristiano | Dora | Emma | Enrique | Ewa | Filiz | Geraint | Giorgio | Gwyneth | Hans | Ines | Ivy | Jacek | Jan | Joanna | Joey | Justin | Karl | Kendra | Kevin | Kimberly | Lea | Liv | Lotte | Lucia | Lupe | Mads | Maja | Marlene | Mathieu | Matthew | Maxim | Mia | Miguel | Mizuki | Naja | Nicole | Penelope | Raveena | Ricardo | Ruben | Russell | Salli | Seoyeon | Takumi | Tatyana | Vicki | Vitoria | Zeina | Zhiyu`
> 
> 必須かどうか：必須ではない

__LanguageCode__
> 声の言語コード。
> 
> type：文字列
> 
> 有効な値：`arb | cmn-CN | cy-GB | da-DK | de-DE | en-AU | en-GB | en-GB-WLS | en-IN | en-US | es-ES | es-MX | es-US | fr-CA | fr-FR | is-IS | it-IT | ja-JP | hi-IN | ko-KR | nb-NO | nl-NL | pl-PL | pt-BR | pt-PT | ro-RO | ru-RU | sv-SE | tr-TR`
> 
> 必須かどうか：必須ではない

__LanguageName__
> 英語で人間が読める言語の名前。
> 
> type：文字列
> 
> 必須かどうか：必須ではない

___Name__
> 声の名前（たとえば、Salli、Kendraなど）。これにより、アプリケーションに表示される可能性のある人間が読める音声名が提供されます。
> 
> type：文字列

> 必須かどうか：必須ではない

__SupportedEngines__
> 特定の音声でサポートされるエンジン（標準またはニューラル）を指定します。
> 
> type：文字列の配列
> 
> 有効な値：`standard | neural`
> 
> 必須かどうか：必須ではない