project update_configuration

Description

複数のプロジェクトの設定を一括で更新します。 既存の設定に対して部分的な更新を行います（設定の完全な置き換えではありません）。

Examples

以下のコマンドは、プロジェクトp1,p2に対して、アノテーションエディタのバージョンをプレビュー版に更新します。

$ annofabcli project update_configuration --project_id p1 p2 \
 --configuration '{"editor_version":"preview"}'

--configuration のJSON構造は、 putProject APIのリクエストボディの configuration と同じです。

よく利用するであろう --configuration の例を以下のJSONに記載します。

{
    # アノテーションエディタのバージョンをプレビュー版
    "editor_version":"preview",

    # 保留中のタスクを除き、1人（オーナー以外）に割り当てられるタスク数の上限
    "max_tasks_per_member": 100,

    # 保留中のタスクを含めて、1人（オーナー以外）に割り当てられるタスク数上限
    "max_tasks_per_member_including_hold": 100,

    # S3プライベートストレージ認可用AWS IAMロールARN
    "private_storage_aws_iam_role_arn": "arn:aws:iam::123456789012:role/YourRoleName",

    # S3プライベートストレージにアクセスする際に、AWS S3 Transfer Accelerationを使用する
    "use_s3_transfer_acceleration": true
}

Usage Details

複数のプロジェクトの設定を一括で更新します。

usage: annofabcli project update_configuration [-h] [--yes]
                                               [--endpoint_url ENDPOINT_URL]
                                               [--annofab_user_id ANNOFAB_USER_ID]
                                               [--annofab_password ANNOFAB_PASSWORD]
                                               [--annofab_pat ANNOFAB_PAT]
                                               [--logdir LOGDIR]
                                               [--disable_log] [--debug] -p
                                               PROJECT_ID [PROJECT_ID ...]
                                               --configuration CONFIGURATION

Named Arguments

-p, --project_id

変更対象プロジェクトのproject_idを指定します。 file:// を先頭に付けると、project_idの一覧が記載されたファイルを指定できます。

--configuration

更新するプロジェクト設定をJSON形式で指定します。既存の設定に対して部分的な更新を行います。JSONの構造については https://annofab.com/docs/api/#operation/putProject のリクエストボディ'configuration'を参照してください。 file:// を先頭に付けると、JSON形式のファイルを指定できます。

global optional arguments

--yes

処理中に現れる問い合わせに対して、常に yes と回答します。

--endpoint_url

Annofab WebAPIのエンドポイントを指定します。

Default: 'https://annofab.com'

--annofab_user_id

Annofabにログインする際のユーザーID

--annofab_password

Annofabにログインする際のパスワード

--annofab_pat

Annofabにログインする際のパーソナルアクセストークン

--logdir

ログファイルを保存するディレクトリを指定します。

Default: .log

--disable_log

ログを無効にします。

--debug

HTTPリクエストの内容やレスポンスのステータスコードなど、デバッグ用のログが出力されます。

プロジェクトのオーナロールを持つユーザで実行してください。