UpdateFileSystem - Amazon Elastic File System
リクエストの構文URI リクエストパラメータリクエストボディレスポンスの構文レスポンス要素エラー以下も参照してください。

UpdateFileSystem

スループットモード、または既存のファイルシステムのプロビジョニングされたスループットの量を更新します。

リクエストの構文

PUT /2015-02-01/file-systems/FileSystemId HTTP/1.1
Content-type: application/json

{
   "ProvisionedThroughputInMibps": number,
   "ThroughputMode": "string"
}

URI リクエストパラメータ

リクエストでは、次の URI パラメータを使用します。

FileSystemId

更新するファイル システムの ID。

長さの制限：最大長は 128 です。

Pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

必須: はい

リクエストボディ

リクエストは以下の JSON 形式のデータを受け入れます。

ProvisionedThroughputInMibps

(オプション) 作成するファイルシステムにプロビジョニングするスループットを、毎秒メビバイト (MiBps) で計測します。ThroughputMode が provisioned に設定されている場合は必須です。有効な値は 1～3414 MiBps で、上限はリージョンによって異なります。この上限数を引き上げるには、Support にお問い合わせください。詳細については、Amazon EFS ユーザーガイドの「引き上げ可能な Amazon EFS クォータ」を参照してください。

型: 倍精度浮動小数点数

値の範囲: 最小値 は 1.0 です。

必須：いいえ

ThroughputMode

（オプション）ファイル システムのスループットモードを更新します。スループットモードを更新しない場合は、リクエストでこの値を指定する必要はありません。ThroughputMode を provisioned に変更する場合、ProvisionedThroughputInMibps の値も設定する必要があります。

型: 文字列

有効な値: bursting | provisioned | elastic

必須：いいえ

レスポンスの構文

HTTP/1.1 202
Content-type: application/json

{
   "AvailabilityZoneId": "string",
   "AvailabilityZoneName": "string",
   "CreationTime": number,
   "CreationToken": "string",
   "Encrypted": boolean,
   "FileSystemArn": "string",
   "FileSystemId": "string",
   "FileSystemProtection": { 
      "ReplicationOverwriteProtection": "string"
   },
   "KmsKeyId": "string",
   "LifeCycleState": "string",
   "Name": "string",
   "NumberOfMountTargets": number,
   "OwnerId": "string",
   "PerformanceMode": "string",
   "ProvisionedThroughputInMibps": number,
   "SizeInBytes": { 
      "Timestamp": number,
      "Value": number,
      "ValueInArchive": number,
      "ValueInIA": number,
      "ValueInStandard": number
   },
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "string"
      }
   ],
   "ThroughputMode": "string"
}

レスポンス要素

アクションが成功すると、HTTP 202 レスポンスが返されます。

サービスから以下のデータが JSON 形式で返されます。

AvailabilityZoneId

ファイルシステムが配置されているアベイラビリティーゾーンの一意で一貫性のある識別子。これは、1 ゾーンファイルシステムでのみ有効です。例えば、use1-az1 は us-east-1 AWS リージョンのアベイラビリティーゾーン ID であり、すべての AWS アカウントで同じ場所を示します。

型: 文字列

AvailabilityZoneName

ファイルシステムが配置されている AWS アベイラビリティーゾーンについて説明します。これは、1ゾーンファイルシステムでのみ有効です。詳細については、「Amazon EFS ユーザーガイド」の「EFS ストレージクラスの使用」を参照してください。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: .+

CreationTime

ファイルシステムが作成された時間 (秒単位) (1970-01-01T00:00:00Z から)。

型: タイムスタンプ

CreationToken

リクエストで指定された不透明な文字列。

型: 文字列

長さの制限：最小長は 1 です。最大長は 64 文字です。

パターン: .+

Encrypted

true の場合はファイルシステムの暗号化を示すブール値。

型: ブール値

FileSystemArn

EFS ファイルシステムの Amazon リソースネーム (ARN) で、形式は arn:aws:elasticfilesystem:region:account-id:file-system/file-system-id です。サンプルデータの例:arn:aws:elasticfilesystem:us-west-2:1111333322228888:file-system/fs-01234567

型: 文字列

FileSystemId

Amazon EFS によって割り当てられるファイルシステムの ID。

型: 文字列

長さの制限：最大長は 128 です。

Pattern: ^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$

FileSystemProtection

ファイルシステムの保護について説明します。

型: FileSystemProtectionDescription オブジェクト

KmsKeyId

暗号化されたファイルシステムの保護に使用する AWS KMS key の ID。

型: 文字列

長さの制限: 最大長は 2048 です。

パターン: ^([0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|mrk-[0-9a-f]{32}|alias/[a-zA-Z0-9/_-]+|(arn:aws[-a-z]*:kms:[a-z0-9-]+:\d{12}:((key/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12})|(key/mrk-[0-9a-f]{32})|(alias/[a-zA-Z0-9/_-]+))))$

LifeCycleState

ファイルシステムのライフサイクルフェーズ。

型: 文字列

有効な値: creating | available | updating | deleting | deleted | error

Name

ファイルシステムには、Name タグをはじめとするタグを追加することができます。詳細については、「CreateFileSystem」を参照してください。ファイルシステムに Name タグがある場合、Amazon EFS はこのフィールドの値を返します。

型: 文字列

長さの制限：最大長は 256 です。

パターン: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

NumberOfMountTargets

ファイルシステムが持つ現在のマウントターゲットの数。詳細については、「CreateMountTarget」を参照してください。

型: 整数

有効な範囲: 最小値 は 0 です。

OwnerId

ファイルシステムを作成する AWS アカウント。

型: 文字列

長さの制限: 最大長は 14 です。

パターン: ^(\d{12})|(\d{4}-\d{4}-\d{4})$

PerformanceMode

ファイル システムのパフォーマンス モード。

型: 文字列

有効な値: generalPurpose | maxIO

ProvisionedThroughputInMibps

ファイルシステムのプロビジョニングされたスループットの量を MiBps で表したもの。ThroughputMode を provisioned に設定したファイルシステムに有効です。

型: 倍精度浮動小数点数

有効な範囲: 最小値 は 1.0 です。

SizeInBytes

ファイルシステムに保存されているデータの最新の測定サイズ（バイト）を Value のフィールドに、そのサイズが決定された時間を Timestamp のフィールドに入力しています。Timestamp 値は、1970-01-01T00:00:00Z 以降の整数秒数です。SizeInBytes値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない場合に結果整合性があります。つまり、SizeInBytesは、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。

型: FileSystemSize オブジェクト

Tags

ファイルシステムに関連するタグで、Tag のオブジェクトの配列として表示されます。

型: Tag オブジェクトの配列

ThroughputMode

ファイルシステムのスループットモードを表示。詳細については、「Amazon EFS ユーザーガイド」の「スループットモード」を参照してください。

型: 文字列

有効な値: bursting | provisioned | elastic

エラー

BadRequest

リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。

HTTP ステータスコード：400

FileSystemNotFound

指定された FileSystemId の値がリクエスタの AWS アカウント に存在しない場合に返されます。

HTTP ステータスコード: 404

IncorrectFileSystemLifeCycleState

ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。

HTTP ステータスコード: 409

InsufficientThroughputCapacity

追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後でもう一度お試しください。

HTTP ステータスコード: 503

InternalServerError

サーバー側でエラーが発生した場合に返されます。

HTTP ステータスコード：500

ThroughputLimitExceeded

スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。

HTTP ステータスコード：400

TooManyRequests

スループットモードを変更するか、プロビジョニングされたスループット値を減らす前に少なくとも 24 時間以上待たない場合に返されます。

HTTP ステータスコード: 429

以下も参照してください。

言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。