翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# API を使用したフライホイールの設定
Amazon Comprehend API を使用して、フライホイールを作成、更新、および削除することができます。
フライホイールが作成されると、Amazon Comprehend は、モデルの各バージョンのトレーニングデータやテストデータなど、フライホイールに必要なすべてのデータを保持するデータレイクを作成します。
フライホイールを削除しても、Amazon Comprehend はフライホイールに関連付けられているデータレイクやモデルを削除しません。
フライホイールがイテレーションを実行しているか、データセットを作成している場合、フライホイールの削除操作は失敗します。
新規フライホイールを作成するにあたっては、セクション「[フライホイールの作成](flywheels-about.md#flywheels-about-create)」の情報を確認しておいてください。
## 既存のモデル用のフライホイールを作成する
既存のモデル用のフライホイールを作成するには、[CreateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html) オペレーションを使用します。
**Example**
```
aws comprehend create-flywheel \
--flywheel-name "myFlywheel2" \
--active-model-arn "modelArn" \
--data-access-role-arn arn:aws::iam::111122223333:role/testFlywheelDataAccess \
--data-lake-s3-uri": "https://{{s3-bucket-endpoint}}" \
```
オペレーションが成功すると、レスポンスにはフライホイールの ARN が含まれます。
```
{
"FlywheelArn": "arn:aws::comprehend:{{aws-region}}:{{111122223333}}:flywheel/name",
"ActiveModelArn": "modelArn"
}
```
## 新しいモデル用のフライホイールを作成する
新しいモデル用のフライホイールを作成するには、[CreateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_CreateFlywheel.html) オペレーションを使用します。
**Example**
```
aws comprehend create-flywheel \
--flywheel-name "myFlywheel2" \
--data-access-role-arn arn:aws::iam::111122223333:role/testFlywheelDataAccess \
--model-type "DOCUMENT_CLASSIFIER" \
--data-lake-s3-uri "s3Uri" \
--task-config file://taskConfig.json
```
taskConfig.json ファイルには以下の内容が含まれます。
```
{
"LanguageCode": "en",
"DocumentClassificationConfig": {
"Mode": "MULTI_LABEL",
"Labels": ["optimism", "anger"]
}
}
```
API レスポンスの本体には以下の内容が含まれます。
```
{
"FlywheelArn": "arn:aws::comprehend:{{aws-region}}:{{111122223333}}:flywheel/name",
"ActiveModelArn": "modelArn"
}
```
## フライホイールの説明を表示する
フライホイールに関する設定済みの情報を取得するには、Amazon Comprehend の [DescribeFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DescribeFlywheel.html) オペレーションを使用します。
```
aws comprehend describe-flywheel \
--flywheel-arn "flywheelArn"
```
API レスポンスの本体には以下の内容が含まれます。
```
{
"FlywheelProperties": {
"FlywheelArn": "arn:aws::comprehend:{{aws-region}}:111122223333:flywheel/myTestFlywheel",
"DataAccessRoleArn": "arn:aws::iam::111122223333:role/Admin",
"TaskConfig": {
"LanguageCode": "en",
"DocumentClassificationConfig": {
"Mode": "MULTI_LABEL"
}
},
"DataLakeS3Uri": "s3://my-test-datalake/flywheelbasictest/myTestFlywheel/schemaVersion=1/20220801T014326Z",
"Status": "ACTIVE",
"ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": 1659318206.102,
"LastModifiedTime": 1659318249.05
}
}
```
## フライホイールを更新する
フライホイールの変更可能な設定値を更新するには、[UpdateFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UpdateFlywheel.html) オペレーションを使用します。
一部の設定フィールドは、サブフィールドを含む JSON 構造になっています。サブフィールドを更新するには、一部であれ、すべてのサブフィールドに値を指定します (Amazon Comprehend は、リクエストにないサブフィールドの値を NULL に設定します)。
`UpdateFlywheel` リクエストで最上位のパラメータを省略した場合、Amazon Comprehend はフライホイール内のパラメータやそのサブフィールドの値を変更しません。
フライホイール上のタグを追加または削除するには、[TagResource](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_TagResource.html) オペレーションと [UntagResource](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_UntagResource.html) オペレーションを使用します。
次の例に示すように、`ActiveModelArn` パラメータを設定することでモデルのバージョンをプロモートすることができます。
```
aws comprehend update-flywheel \
--region {{aws-region}} \
--flywheel-arn "flywheelArn" \
--active-model-arn "modelArn" \
```
API レスポンスの本体には以下の内容が含まれます。
```
{
"FlywheelArn": "arn:aws::comprehend:{{aws-region}}:{{111122223333}}:flywheel/name",
"ActiveModelArn": "modelArn"
}
```
## フライホイールを削除する
フライホイールを削除するには、Amazon Comprehendの[DeleteFlywheel](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_DeleteFlywheel.html) オペレーションを使用します。
```
aws comprehend delete-flywheel \
--flywheel-arn "flywheelArn"
```
正常な API レスポンスのメッセージ本体は空になります。
## フライホイールを一覧表示する
現在のリージョンのフライホイールのリストを取得するには、Amazon Comprehend の [ListFlyWheels](https://docs.aws.amazon.com/comprehend/latest/APIReference/API_ListFlywheels.html) オペレーションを使用します。
```
aws comprehend list-flywheel \
--region {{aws-region}} \
--endpoint-url "uri"
```
API レスポンスの本体には以下の内容が含まれます。
```
{
"FlywheelSummaryList": [
{
"FlywheelArn": "arn:aws::comprehend:{{aws-region}}:111122223333:flywheel/myTestFlywheel",
"DataLakeS3Uri": "s3://my-test-datalake/flywheelbasictest/myTestFlywheel/schemaVersion=1/20220801T014326Z",
"Status": "ACTIVE",
""ModelType": "DOCUMENT_CLASSIFIER",
"CreationTime": 1659318206.102,
"LastModifiedTime": 1659318249.05
}
]
}
```