翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
# Amazon EFS API
Amazon EFS API は、[HTTP (RFC 2616)](https://www.ietf.org/rfc/rfc2616.txt) に基づくネットワークプロトコルです。各 API コールについて、ファイルシステムを管理する AWS リージョン の リージョン固有の Amazon EFS API エンドポイントへの HTTP リクエストを行います。API は、HTTP リクエスト/応答本文に JSON (RFC 4627) ドキュメントを使用します。
Amazon EFS API は RPC モデルです。このモデルでは、オペレーションの固定の設定があり、各オペレーションの構文は、事前に操作しなくてもクライアントに知られています。次のセクションでは、理論上の RPC 表記を使用する各 API オペレーションについて説明します。それぞれには、オンラインでは表示されないオペレーション名があります。各オペレーションでは、トピックが HTTP リクエスト要素のマッピングを指定します。
リクエストがマッピングされる特定のAmazon EFSオペレーションは、リクエストのメソッド（GET、PUT、POST、またはDELETE）と、Request-URIがマッチする様々なパターンの組み合わせによって決定されます。オペレーションが PUT または POST の場合、Amazon EFSは Request-URI パスセグメント、クエリ パラメータ、およびリクエストボディ内のJSON オブジェクトからコール引数を抽出します。
**注記**
`CreateFileSystem` といったオペレーション名はオンラインには表示されませんが、これらのオペレーション名は AWS Identity and Access Management (IAM) ポリシーにとって意味があります。詳細については、「[Amazon EFS のためのアイデンティティとアクセス管理](security-iam.md)」を参照してください。
オペレーション名は、コマンドラインツールのコマンド名や AWS SDK API の要素にも使用されます。たとえば、`CreateFileSystem` オペレーションにマッピングする `create-file-system` という AWS CLI コマンドがあります。
オペレーション名は、Amazon EFS API コールの AWS CloudTrail ログ内にも表示されます。
## API エンドポイント
エンドポイントは、AWS ウェブサービスのエントリポイントとなる URL です。Amazon EFS は以下のエンドポイントタイプをサポートします。
+ IPv4 エンドポイント
+ デュアルスタック (IPv4 および IPv6) エンドポイント
+ [FIPS エンドポイント](https://docs.aws.amazon.com/general/latest/gr/rande.html#FIPS-endpoints)
リクエストを行うと、使用するエンドポイントを指定できます。エンドポイントを指定しない場合、デフォルトで IPv4 エンドポイントが使用されます。別のエンドポイントタイプを使用するには、リクエストで指定する必要があります。これを行う方法の例については、「[エンドポイントの指定](#endpoints-specifying)」を参照してください。使用可能なエンドポイントの表については、「[Amazon EFS のエンドポイントとクォータ](https://docs.aws.amazon.com/general/latest/gr/elasticfilesystem.html)」を参照してください。
### IPv4 エンドポイント
IPv4 エンドポイントは IPv4 トラフィックのみをサポートします。IPv4 エンドポイントは、全リージョンで利用できます。IPv4 エンドポイントの形式は、リージョンによって異なります。
+ AWS 商用リージョンの IPv4 エンドポイントの場合、形式は `elasticfilesystem.region.amazonaws.com` です。
例えば、`elasticfilesystem.us-west-2.amazonaws.com` をエンドポイントとして指定した場合、リクエストは 米国西部 (オレゴン) リージョン (us-west-2) のエンドポイントに転送されます。
+ 中国リージョンの IPv4 エンドポイントの場合、形式は `elasticfilesystem.region.amazonaws.com.cn` です。
例えば、中国 (北京) リージョンの Amazon EFS API エンドポイントは `elasticfilesystem.cn-north-1.amazonaws.com.cn` です。
### デュアルスタック (IPv4 および IPv6) エンドポイント
デュアルスタックエンドポイントは、IPv4 と IPv6 トラフィックの両方をサポートします。デュアルスタックエンドポイントにリクエストを行うと、エンドポイント URL は、ネットワークとクライアントが使用するプロトコルに応じて IPv6 または IPv4 アドレスに解決されます。デュアルスタックエンドポイントの形式は、リージョンによって異なります。
+ AWS 商用リージョンのデュアルスタックエンドポイントの場合、形式は `efs.aws-region.api.aws` です。
例えば、米国西部 (オレゴン) リージョン (us-west-2) のデュアルスタックエンドポイントは `efs.eu-west-2.api.aws` です。
+ 中国リージョンのデュアルスタックエンドポイントの場合、形式は `efs.region.api.amazonwebservices.com.cn` です。
例えば、中国 (北京) リージョンのデュアルスタックエンドポイントは `efs.cn-north-1.api.amazonwebservices.com.cn` です。
### エンドポイントの指定
次の例は、Amazon EFS の AWS CLI を使用して米国西部 (北カリフォルニア) リージョン (us-west-1) のエンドポイントを指定する方法を示しています。
IPv4
```
aws efs get-rest-apis --region us-west-1 --endpoint-url https://elasticfilesystem.us-west-1.amazonaws.com
```
デュアルスタック
```
aws efs get-rest-apis --region us-west-1 --endpoint-url https://efs.us-west-1.api.aws
```
## API バージョン
コールに使用される API のバージョンは、リクエスト URI の最初のパスセグメントにより特定されます。この形式は ISO 8601 の日付になります。例については、「[CreateFileSystem](API_CreateFileSystem.md)」を参照してください。
ドキュメントでは、API バージョン 2015-02-01 について説明されています。
## 関連トピック
以下のセクションでは、API オペレーション、認証リクエスト用の署名を作成する方法、IAM ポリシーを使用して、これらの API オペレーションのためのアクセス許可を付与する方法を説明します。
+ [Amazon EFS のためのアイデンティティとアクセス管理](security-iam.md)
+ [アクション](API_Operations.md)
+ [データ型](API_Types.md)
## Amazon EFS のクエリ API リクエスト率の使用
Amazon EFS API のリクエストはリージョンごとに各 AWS アカウント に対してスロットルされ、サービスパフォーマンスの向上に役立ちます。Amazon EFS API コールはすべて、アプリケーション、AWS CLI、Amazon EFS コンソールのいずれから発信されたかにかかわらず、許可される API リクエスト率の最大値を超えることはできません。最大 API リクエスト率は AWS リージョン 間で異なる場合があります。API リクエストは、基盤となる AWS アカウント に属性があります。
API リクエストがそのカテゴリの API リクエスト率を超過する場合、`ThrottlingException` エラーコードが返されます。このエラーを回避するには、アプリケーションが API リクエストを再試行する率を低くします。これは、ポーリングの際に注意深くし、エクスポネンシャルバックオフの再試行を使用することにより行えます。
### ポーリング
アプリケーションにより API オペレーションを繰り返しコールして、ステータスの更新をチェックする必要がある場合があります。ポーリングを開始する前に、リクエストの予想完了時間を指定します。ポーリングを開始するとき、連続するリクエストの間に適切なスリープ間隔を使用します。最良の結果を得るには、漸増スリープ間隔を使用します。
### 再試行またはバッチ処理
アプリケーションは、API リクエストが失敗した後に再試行するか、複数のリソースを処理する必要がある場合があります (たとえば、Amazon EFS ファイルシステムすべて)。API リクエストの率を下げるには、連続するリクエストの間に適切なスリープ間隔を使用します。最良の結果を得るには、漸増または可変スリープ間隔を使用します。
### スリープ間隔の計算
API リクエストをポーリングまたは再試行する必要がある場合は、エクスポネンシャルバックオフ アルゴリズムを使用して API コール間のスリープ間隔を計算することをお勧めします。エクスポネンシャルバックオフの背後にある考え方は、連続したエラー応答の再試行間の待機時間を徐々に長く使用することです。詳細およびこのアルゴリズムの実装の例については、「*Amazon Web Services 全般のリファレンス*」の「[再試行動作](https://docs.aws.amazon.com/general/latest/gr/api-retries.html)」を参照してください。
# アクション
以下のアクションがサポートされています:
+ [CreateAccessPoint](API_CreateAccessPoint.md)
+ [CreateFileSystem](API_CreateFileSystem.md)
+ [CreateMountTarget](API_CreateMountTarget.md)
+ [CreateReplicationConfiguration](API_CreateReplicationConfiguration.md)
+ [CreateTags](API_CreateTags.md)
+ [DeleteAccessPoint](API_DeleteAccessPoint.md)
+ [DeleteFileSystem](API_DeleteFileSystem.md)
+ [DeleteFileSystemPolicy](API_DeleteFileSystemPolicy.md)
+ [DeleteMountTarget](API_DeleteMountTarget.md)
+ [DeleteReplicationConfiguration](API_DeleteReplicationConfiguration.md)
+ [DeleteTags](API_DeleteTags.md)
+ [DescribeAccessPoints](API_DescribeAccessPoints.md)
+ [DescribeAccountPreferences](API_DescribeAccountPreferences.md)
+ [DescribeBackupPolicy](API_DescribeBackupPolicy.md)
+ [DescribeFileSystemPolicy](API_DescribeFileSystemPolicy.md)
+ [DescribeFileSystems](API_DescribeFileSystems.md)
+ [DescribeLifecycleConfiguration](API_DescribeLifecycleConfiguration.md)
+ [DescribeMountTargets](API_DescribeMountTargets.md)
+ [DescribeMountTargetSecurityGroups](API_DescribeMountTargetSecurityGroups.md)
+ [DescribeReplicationConfigurations](API_DescribeReplicationConfigurations.md)
+ [DescribeTags](API_DescribeTags.md)
+ [ListTagsForResource](API_ListTagsForResource.md)
+ [ModifyMountTargetSecurityGroups](API_ModifyMountTargetSecurityGroups.md)
+ [PutAccountPreferences](API_PutAccountPreferences.md)
+ [PutBackupPolicy](API_PutBackupPolicy.md)
+ [PutFileSystemPolicy](API_PutFileSystemPolicy.md)
+ [PutLifecycleConfiguration](API_PutLifecycleConfiguration.md)
+ [TagResource](API_TagResource.md)
+ [UntagResource](API_UntagResource.md)
+ [UpdateFileSystem](API_UpdateFileSystem.md)
+ [UpdateFileSystemProtection](API_UpdateFileSystemProtection.md)
# CreateAccessPoint
EFS アクセスポイントの作成 アクセスポイントは、EFS ファイルシステムに対するアプリケーション固有のビューで、オペレーティングシステムのユーザーとグループ、およびファイルシステムパスを、アクセスポイントを介して行われたすべてのファイルシステムリクエストに適用されます。オペレーティングシステムのユーザーおよびグループは、NFS クライアントから提供されるすべての アイデンティティ 情報を上書きします。ファイルシステムのパスは、アクセスポイントのルートディレクトリとしてクライアントに公開されます。アクセスポイントを使用するアプリケーションは、アプリケーション自体のディレクトリとサブディレクトリ内のデータにのみアクセスできます。ファイルシステムは、引き上げをリクエストしない限り、最大 10,000 個のアクセスポイントを持つことができます。詳細はこちら、「[EFS アクセスポイントを使用してファイルシステムをマウントする](https://docs.aws.amazon.com/efs/latest/ug/efs-access-points.html)」を参照してください。
**注記**
同じファイルシステムにアクセスポイントを作成する複数のリクエストが連続して送信され、そのファイルシステムがアクセスポイントの制限に近い場合、これらのリクエストに対するスロットリングレスポンスが調整される場合があります。これは、ファイルシステムが指定されたアクセスポイントの制限を超えないようにするためです。
このオペレーションには、`elasticfilesystem:CreateAccessPoint` アクションに対するアクセス許可が必要です。
アクセスポイントは作成時にタグ付けをすることができます。作成アクションでタグが指定されている場合、IAM は `elasticfilesystem:TagResource` アクションに対して追加の認可を実行して、ユーザーがタグを作成する認可を持っているかどうかを確認します。したがって、`elasticfilesystem:TagResource` アクションを使用するための明示的なアクセス許可を付与する必要があります。詳細については、「[リソース作成時にタグ付けするアクセス許可の付与](https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html)」を参照してください。
## リクエストの構文
```
POST /2015-02-01/access-points HTTP/1.1
Content-type: application/json
{
"ClientToken": "string",
"FileSystemId": "string",
"PosixUser": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": number,
"OwnerUid": number,
"Permissions": "string"
},
"Path": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [ClientToken](#API_CreateAccessPoint_RequestSyntax) **
べき等の作成を保証するために Amazon EFS が使用する最大 64 の ASCII 文字の文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
必須: はい
** [FileSystemId](#API_CreateAccessPoint_RequestSyntax) **
アクセスポイントがアクセスを提供する EFS ファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** [PosixUser](#API_CreateAccessPoint_RequestSyntax) **
アクセスポイントを使用して行われたすべてのファイル システムリクエストに適用されたオペレーティングシステムのユーザーおよびグループ。
型: [PosixUser](API_PosixUser.md) オブジェクト
必須: いいえ
** [RootDirectory](#API_CreateAccessPoint_RequestSyntax) **
アクセスポイントを使用する NFS クライアントに対して、アクセスポイントがファイルシステムのルートディレクトリとして公開する EFS ファイルシステム上のディレクトリを指定します。アクセスポイントを使用するクライアントは、ルートディレクトリ以下にのみアクセスできます。指定した `RootDirectory` > `Path` が存在しない場合、Amazon EFS はそれを作成し、クライアントがアクセスポイントに接続する際に `CreationInfo` 設定を適用します。`RootDirectory` を指定する際には、`Path`、`CreationInfo` を指定する必要があります。
Amazon EFS では、CreationInfo (OwnUid、OwnGID、ディレクトリのアクセス許可) を指定した場合にのみ、ルートディレクトリが作成されます。この情報を指定しない場合、Amazon EFS はルートディレクトリを作成しません。ルートディレクトリが存在しない場合に、アクセスポイントを使用してマウントしようとすると、失敗します。
型: [RootDirectory](API_RootDirectory.md) オブジェクト
必須: いいえ
** [Tags](#API_CreateAccessPoint_RequestSyntax) **
アクセスポイントに関連付けられたタグを作成します。各タグはキーバリューのペアです。各キーは一意である必要があります。詳細については、「 * AWS 全般のリファレンスガイド*[」の AWS 「リソースのタグ付け](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)」を参照してください。
タイプ: [Tag](API_Tag.md) オブジェクトの配列
必須: いいえ
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"AccessPointArn": "string",
"AccessPointId": "string",
"ClientToken": "string",
"FileSystemId": "string",
"LifeCycleState": "string",
"Name": "string",
"OwnerId": "string",
"PosixUser": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": number,
"OwnerUid": number,
"Permissions": "string"
},
"Path": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AccessPointArn](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイントに関連付けられた一意の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$`
** [AccessPointId](#API_CreateAccessPoint_ResponseSyntax) **
Amazon EFS によって割り当てられたアクセスポイントの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`
** [ClientToken](#API_CreateAccessPoint_ResponseSyntax) **
冪等性の作成を保証するためにリクエストで指定された不透明な文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [FileSystemId](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイントが適用される EFS ファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [LifeCycleState](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイントのライフサイクルフェーズを識別します。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
** [Name](#API_CreateAccessPoint_ResponseSyntax) **
このアクセスポイントの名前。これは、`Name` タグの値です。
タイプ: 文字列
** [OwnerId](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイントリソースを所有 AWS アカウント する を識別します。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
** [PosixUser](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイント上の、ユーザー ID、グループ ID、およびセカンダリグループ ID を含む完全な POSIX アイデンティティ。アクセスポイントを使用する NFS クライアントによるすべてのファイル オペレーションに使用されます。
型: [PosixUser](API_PosixUser.md) オブジェクト
** [RootDirectory](#API_CreateAccessPoint_ResponseSyntax) **
アクセスポイントを使用して、アクセスポイントが NFS クライアントにルートディレクトリとして公開する EFS ファイルシステム上のディレクトリ。
型: [RootDirectory](API_RootDirectory.md) オブジェクト
** [Tags](#API_CreateAccessPoint_ResponseSyntax) **
タグオブジェクトの配列として表示される、アクセスポイントに関連付けられたタグ。
型: [Tag](API_Tag.md) オブジェクトの配列
## エラー
** AccessPointAlreadyExists **
作成しようとしているアクセスポイントがすでに存在し、リクエストで指定した作成 トークンとともに返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** AccessPointLimitExceeded **
AWS アカウント がファイルシステムごとに許可されるアクセスポイントの最大数を既に作成している場合に返されます。詳細については、「[https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region](https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region)」を参照してください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 403
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータがないなどのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ThrottlingException **
`CreateAccessPoint` API アクションの呼び出しが速すぎて、ファイルシステム上のアクセスポイントの数が [120 の制限](https://docs.aws.amazon.com/efs/latest/ug/limits.html#limits-efs-resources-per-account-per-region)に近づいた場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 429
## 以下も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/CreateAccessPoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreateAccessPoint)
# CreateFileSystem
空のファイルシステムを新しく作成します。このオペレーションでは、Amazon EFS がべき等の作成を保証するために使用するリクエストに作成トークンが必要です (同じ作成トークンを使用してオペレーションを呼び出しても効果はありません)。指定された作成トークン AWS アカウント を持つ発信者の が所有するファイルシステムが現在存在しない場合、このオペレーションは以下を実行します。
+ 空のファイルシステムを新しく作成します。ファイルシステムには、Amazon EFS に割り当てられた ID と、初期ライフサイクル状態 `creating` があります。
+ 作成したファイルシステムの説明を返します。
それ以外の場合、このオペレーションは既存のファイルシステムの ID とともに `FileSystemAlreadyExists` エラーを返します。
**注記**
基本的なユースケースでは、作成トークンにランダムに生成された UUID を使用できます。
べき等のオペレーションを使用すると、余分なファイルシステムを作成するリスクなしに `CreateFileSystem` コールを再試行できます。これは、ファイルシステムが実際に作成されたかどうかが不明確なまま、最初のコールが失敗したときに発生する可能性があります。例としては、トランスポートレベルのタイムアウトが発生したか、接続がリセットされたことが挙げられます。同じ作成 トークンを使用している限り、最初のコールでファイルシステムの作成に成功した場合、クライアントは `FileSystemAlreadyExists` エラーからその存在を知ることができます。
詳細については、[Amazon EFS ユーザーガイド](https://docs.aws.amazon.com/efs/latest/ug/creating-using-create-fs.html#creating-using-create-fs-part1)の「*ファイルシステムの作成*」を参照してください。
**注記**
`CreateFileSystem` コールは、ファイルシステムのライフサイクル状態がまだ `creating` である間に戻ります。[DescribeFileSystems](API_DescribeFileSystems.md) オペレーションをコールすることでファイルシステムの作成ステータスをチェックできます。これにより、ファイルシステムの状態が返されます。
このオペレーションでは、ファイルシステム用に選択したオプションの `PerformanceMode` パラメータを受け入れます。すべてのファイルシステムに `generalPurpose` `PerformanceMode` をお勧めします。`maxIO` モードは前世代のパフォーマンスタイプであり、`generalPurpose` モードよりも高いレイテンシーを許容できる高度に並列化されたワークロード向けに設計されています。`MaxIO` モードは、1 ゾーンファイルシステムやエラスティックスループットを使用するファイルシステムではサポートされません。
`PerformanceMode` は、ファイルシステムの作成後は変更できません。詳細については、「[Amazon EFS パフォーマンスモード](https://docs.aws.amazon.com/efs/latest/ug/performance.html#performancemodes.html)」を参照してください。
ファイルシステムのスループットモードは、`ThroughputMode`パラメータで設定できます。
ファイルシステムが完全に作成されると、Amazon EFS はそのライフサイクル状態を `available` に設定します。この時点で、VPC でファイルシステムの 1 つ以上のマウントターゲットを作成できます。詳細については、「[CreateMountTarget](API_CreateMountTarget.md)」を参照してください。マウントターゲットを使用して、Amazon EFS ファイルシステムを VPC 内の EC2 インスタンスにマウントします。詳細については、「[Amazon EFS の仕組み](https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html)」を参照してください。
このオペレーションには、`elasticfilesystem:CreateFileSystem` アクションに対するアクセス許可が必要です。
ファイルシステムは作成時にタグ付けできます。作成アクションでタグが指定されている場合、IAM は `elasticfilesystem:TagResource` アクションに対して追加の認可を実行して、ユーザーがタグを作成する認可を持っているかどうかを確認します。したがって、`elasticfilesystem:TagResource` アクションを使用するための明示的なアクセス許可を付与する必要があります。詳細については、「[リソース作成時にタグ付けするアクセス許可の付与](https://docs.aws.amazon.com/efs/latest/ug/using-tags-efs.html#supported-iam-actions-tagging.html)」を参照してください。
## リクエストの構文
```
POST /2015-02-01/file-systems HTTP/1.1
Content-type: application/json
{
"AvailabilityZoneName": "string",
"Backup": boolean,
"CreationToken": "string",
"Encrypted": boolean,
"KmsKeyId": "string",
"PerformanceMode": "string",
"ProvisionedThroughputInMibps": number,
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"ThroughputMode": "string"
}
```
## URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [AvailabilityZoneName](#API_CreateFileSystem_RequestSyntax) **
1 ゾーンファイルシステムの場合は、ファイルシステムを作成する AWS アベイラビリティーゾーンを指定します。形式 `us-east-1a` を使用して、アベイラビリティーゾーンを指定します。1 ゾーンファイルシステムの詳細については、「**Amazon EFS ユーザーガイド」の「[EFS ファイルシステムのタイプ](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type)」を参照してください。
1 ゾーンファイルシステムは、Amazon EFS AWS リージョン が利用可能な のすべてのアベイラビリティーゾーンで利用できるわけではありません。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
必須: いいえ
** [Backup](#API_CreateFileSystem_RequestSyntax) **
作成するファイルシステム上で自動バックアップを有効にするかどうかを指定します。自動バックアップを有効にするには、値を `true` に設定します。1 ゾーンファイルシステムを作成している場合、デフォルトで自動バックアップが有効になります。詳細については、*Amazon EFS ユーザーガイド*の 「[自動バックアップ](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)」を参照してください。
デフォルトは `false` です。ただし、`AvailabilityZoneName` を指定した場合、デフォルトは `true` です。
AWS Backup は、Amazon EFS が利用可能なすべての AWS リージョン で利用できるわけではありません。
タイプ: ブール値
必須: いいえ
** [CreationToken](#API_CreateFileSystem_RequestSyntax) **
最大 64 バイトの ASCII 文字の文字列。Amazon EFS では、べき等の作成を保証するためにこれを使用します。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
必須: はい
** [Encrypted](#API_CreateFileSystem_RequestSyntax) **
このブール値が true の場合、暗号化されたファイルシステムが作成されます。暗号化されたファイルシステムを作成するときは、既存の AWS Key Management Service キー (KMS キー) を指定するオプションがあります。KMS キーを指定しない場合、Amazon EFS のデフォルトの KMS キー (`/aws/elasticfilesystem`) が暗号化されたファイルシステムの保護に使用されます。
型: ブール値
必須: いいえ
** [KmsKeyId](#API_CreateFileSystem_RequestSyntax) **
暗号化されたファイルシステムの保護に使用される KMS キーの ID。このパラメータは、デフォルト以外の KMS キーを使用する場合にのみ必要です。このパラメータが指定されない場合、Amazon EFS のデフォルトの KMS キーが使用されます。以下の形式を使用して、KMS キー ID を指定できます。
+ キー ID - キーの一意の識別子 (例: `1234abcd-12ab-34cd-56ef-1234567890ab`)。
+ ARN - キーの Amazon リソースネーム (ARN) (例: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`)。
+ キーのエイリアス - 以前に作成したキーの表示名 (例: `alias/projectKey1`)。
+ キー エイリアス ARN - キー エイリアスの ARN (例: `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`)。
`KmsKeyId` を使用した場合、[CreateFileSystem:Encrypted](#efs-CreateFileSystem-request-Encrypted) パラメータを true に設定する必要があります。
EFS は、対称 KMS キーのみを受け入れます。Amazon EFS ファイルシステムでは非対称 KMS キーを使用することはできません。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^([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/_-]+))))$`
必須: いいえ
** [PerformanceMode](#API_CreateFileSystem_RequestSyntax) **
ファイル システムのパフォーマンス モード。すべてのファイルシステムに `generalPurpose` パフォーマンスモードをお勧めします。`maxIO` パフォーマンスモードを使用しているファイルシステムでは、ほとんどのファイルオペレーションのレイテンシーがわずかに大きくなる代わりに、より高いレベルの集計スループットと 1 秒あたりのオペレーションにスケールできます。パフォーマンスモードは、ファイルシステムの作成後は変更できません。`maxIO` モードは、1 ゾーンファイルシステムではサポートされません。
最大 I/O ではオペレーションごとのレイテンシーが高くなるため、すべてのファイルシステムに汎用パフォーマンスモードを使用することをお勧めします。
デフォルトは `generalPurpose` です。
型: 文字列
有効な値：`generalPurpose | maxIO`
必須：いいえ
** [ProvisionedThroughputInMibps](#API_CreateFileSystem_RequestSyntax) **
作成しているファイルシステムにプロビジョニングするスループットを、毎秒メビバイト (MiBps) で計測します。`ThroughputMode` が `provisioned` に設定されている場合は必須です。有効な値は 1～3414 MiBps で、上限はリージョンによって異なります。この制限を引き上げるには、 にお問い合わせください サポート。詳細については、*Amazon EFS ユーザーガイド*の「[引き上げ可能な Amazon EFS クォータ](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)」を参照してください。
型: 倍精度浮動小数点数
値の範囲: 最小値 は 1.0 です。
必須: いいえ
** [Tags](#API_CreateFileSystem_RequestSyntax) **
ファイルシステムに関連付けられている 1 つ以上のタグを作成するために使用します。各タグはユーザー定義のキーバリューのペアです。`"Key":"Name","Value":"{value}"` キーバリューのペアを含めることで、作成時にファイルシステムに名前を付けます。各キーは一意である必要があります。詳細については、「 * AWS 全般のリファレンスガイド*[」の AWS 「リソースのタグ付け](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html)」を参照してください。
タイプ: [Tag](API_Tag.md) オブジェクトの配列
必須: いいえ
** [ThroughputMode](#API_CreateFileSystem_RequestSyntax) **
ファイルシステムのスループットモードを指定します。モードには、`bursting`、`provisioned`、`elastic` などがあります。`ThroughputMode` を `provisioned` に設定した場合、`ProvisionedThroughputInMibps` の値も設定する必要があります。ファイルシステムを作成した後は、一定の時間制限付きで、ファイルシステムのプロビジョニングされたスループットを下げたり、スループットモードを変更したりすることができます。詳細については、Amazon EFS ユーザーガイド の「[プロビジョニングモードでのスループットの指定](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput)」を参照してください。
デフォルトは `bursting` です。
型: 文字列
有効な値：`bursting | provisioned | elastic`
必須：いいえ
## レスポンスの構文
```
HTTP/1.1 201
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 201 レスポンスが返されます。
サービスから以下のデータが JSON 形式で返されます。
** [AvailabilityZoneId](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムが配置されているアベイラビリティーゾーンの一意で一貫性のある識別子。これは、1 ゾーンファイルシステムでのみ有効です。たとえば、 `use1-az1`は us-east-1 のアベイラビリティーゾーン ID であり AWS リージョン、すべての に同じ場所があります AWS アカウント。
タイプ: 文字列
** [AvailabilityZoneName](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムが配置されている AWS アベイラビリティーゾーンについて説明し、1 ゾーンファイルシステムでのみ有効です。詳細については、「**Amazon EFS ユーザーガイド」の「[EFS ストレージクラスの使用](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)」を参照してください。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [CreationTime](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムが作成された時間 (秒単位) (1970-01-01T00:00:00Z から)。
型: タイムスタンプ
** [CreationToken](#API_CreateFileSystem_ResponseSyntax) **
リクエストで指定された不透明な文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [Encrypted](#API_CreateFileSystem_ResponseSyntax) **
true の場合はファイルシステムの暗号化を示すブール値。
型: ブール値
** [FileSystemArn](#API_CreateFileSystem_ResponseSyntax) **
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](#API_CreateFileSystem_ResponseSyntax) **
Amazon EFS によって割り当てられるファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [FileSystemProtection](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムの保護について説明します。
型: [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md) オブジェクト
** [KmsKeyId](#API_CreateFileSystem_ResponseSyntax) **
暗号化されたファイルシステムを保護する AWS KMS key ために使用される の ID。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^([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](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムのライフサイクルフェーズ。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
** [Name](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムには、`Name` タグをはじめとするタグを追加することができます。詳細については、「[CreateFileSystem](#API_CreateFileSystem)」を参照してください。ファイルシステムに `Name` タグがある場合、Amazon EFS はこのフィールドの値を返します。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
** [NumberOfMountTargets](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムが持つ現在のマウントターゲットの数。詳細については、「[CreateMountTarget](API_CreateMountTarget.md)」を参照してください。
型: 整数
有効範囲: 最小値 は 0 です。
** [OwnerId](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムを AWS アカウント 作成した 。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
** [PerformanceMode](#API_CreateFileSystem_ResponseSyntax) **
ファイル システムのパフォーマンス モード。
型: 文字列
有効な値：`generalPurpose | maxIO`
** [ProvisionedThroughputInMibps](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムのプロビジョニングされたスループットの量を MiBps で表したもの。`ThroughputMode` を `provisioned` に設定したファイルシステムに有効です。
型: 倍精度浮動小数点数
有効な範囲: 最小値 は 1.0 です。
** [SizeInBytes](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムに保存されているデータの最新の測定サイズ（バイト）を `Value` のフィールドに、そのサイズが決定された時間を `Timestamp` のフィールドに入力しています。`Timestamp` 値は、1970-01-01T00:00:00Z 以降の整数秒数です。`SizeInBytes`値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない場合に結果整合性があります。つまり、`SizeInBytes`は、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。
型: [FileSystemSize](API_FileSystemSize.md) オブジェクト
** [Tags](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムに関連するタグで、`Tag` のオブジェクトの配列として表示されます。
型: [Tag](API_Tag.md) オブジェクトの配列
** [ThroughputMode](#API_CreateFileSystem_ResponseSyntax) **
ファイルシステムのスループットモードを表示。詳細については、「**Amazon EFS ユーザーガイド」の「[スループットモード](https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes)」を参照してください。
型: 文字列
有効な値：`bursting | provisioned | elastic`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemAlreadyExists **
作成しようとしているファイルシステムがすでに存在し、指定した作成トークンを使用して返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** FileSystemLimitExceeded **
AWS アカウント がアカウントごとに許可されるファイルシステムの最大数を既に作成している場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 403
** InsufficientThroughputCapacity **
追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後でもう一度お試しください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 503
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ThroughputLimitExceeded **
スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** UnsupportedAvailabilityZone **
リクエストされた Amazon EFS 機能が指定されたアベイラビリティーゾーンで利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 例
### 暗号化された EFS ファイルシステムの作成
次の例では、POST リクエストを送信して、自動バックアップが有効になっている `us-west-2` リージョンにファイルシステムを作成します。このリクエストでは、べき等の作成トークンとして `myFileSystem1` を指定します。
#### リクエスト例
```
POST /2015-02-01/file-systems HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T215117Z
Authorization: <...>
Content-Type: application/json
Content-Length: 42
{
"CreationToken" : "myFileSystem1",
"PerformanceMode" : "generalPurpose",
"Backup": true,
"Encrypted": true,
"Tags":[
{
"Key": "Name",
"Value": "Test Group1"
}
]
}
```
#### レスポンス例
```
HTTP/1.1 201 Created
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 319
{
"ownerId":"251839141158",
"CreationToken":"myFileSystem1",
"Encrypted": true,
"PerformanceMode" : "generalPurpose",
"fileSystemId":"fs-01234567",
"CreationTime":"1403301078",
"LifeCycleState":"creating",
"numberOfMountTargets":0,
"SizeInBytes":{
"Timestamp": 1403301078,
"Value": 29313618372,
"ValueInArchive": 201156,
"ValueInIA": 675432,
"ValueInStandard": 29312741784
},
"Tags":[
{
"Key": "Name",
"Value": "Test Group1"
}
],
"ThroughputMode": "elastic"
}
```
### 1 ゾーンの可用性を備えた暗号化 EFS ファイルシステムを作成する
次の例では、POST リクエストを送信して、自動バックアップが有効になっている `us-west-2` リージョンにファイルシステムを作成します。ファイルシステムには、`us-west-2b` アベイラビリティーゾーンに 1 ゾーンストレージがあります。
#### リクエスト例
```
POST /2015-02-01/file-systems HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T215117Z
Authorization: <...>
Content-Type: application/json
Content-Length: 42
{
"CreationToken" : "myFileSystem2",
"PerformanceMode" : "generalPurpose",
"Backup": true,
"AvailabilityZoneName": "us-west-2b",
"Encrypted": true,
"ThroughputMode": "elastic",
"Tags":[
{
"Key": "Name",
"Value": "Test Group1"
}
]
}
```
#### レスポンス例
```
HTTP/1.1 201 Created
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 319
{
"ownerId":"251839141158",
"CreationToken":"myFileSystem1",
"Encrypted": true,
"AvailabilityZoneId": "usew2-az2",
"AvailabilityZoneName": "us-west-2b",
"PerformanceMode" : "generalPurpose",
"fileSystemId":"fs-01234567",
"CreationTime":"1403301078",
"LifeCycleState":"creating",
"numberOfMountTargets":0,
"SizeInBytes":{
"Timestamp": 1403301078,
"Value": 29313618372,
"ValueInArchive": 201156,
"ValueInIA": 675432,
"ValueInStandard": 29312741784
},
"Tags":[
{
"Key": "Name",
"Value": "Test Group1"
}
],
"ThroughputMode": "elastic"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/CreateFileSystem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreateFileSystem)
# CreateMountTarget
ファイルシステムのマウントターゲットを作成します。その後、マウントターゲットを使用してファイルシステムを EC2 インスタンスにマウントできます。マウントターゲットの詳細については、「[マウントターゲットの管理](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs.html)」を参照してください。
EFS ファイルシステムのマウントターゲットを作成するには、ファイルシステムのライフサイクル状態が `available` である必要があります。詳細については、「[DescribeFileSystems](API_DescribeFileSystems.md)」を参照してください。
マウントターゲットを作成した後、Amazon EFS は `MountTargetId` と IP アドレス (`Ipv6Address` または `IpAddress`) を含むレスポンスを返します。この IP アドレスは、ファイルシステムを EC2 インスタンスにマウントするときに使用します。ファイルシステムをマウントするときにマウントターゲットの DNS 名を使用することもできます。マウントターゲットを使用してファイルシステムをマウントする EC2 インスタンスは、マウントターゲットの DNS 名をその IP アドレスに解決できます。詳細については、「[Amazon EFS の仕組み](https://docs.aws.amazon.com/efs/latest/ug/how-it-works.html)」を参照してください。
ファイルシステムのマウントターゲットは 1 つの VPC でのみ作成でき、アベイラビリティーゾーンごとにマウントターゲットは 1 つだけ存在できます。詳細については、「[マウントターゲットの作成](https://docs.aws.amazon.com/efs/latest/ug/manage-fs-access-create-delete-mount-targets.html)」を参照してください。
リクエストが要件を満たす場合、Amazon EFS は次のことを行います。
+ 指定したサブネットに新しいマウントターゲットを作成します。
+ 以下を使用して、サブネットに新しいネットワークインターフェイスを作成します。
+ ` fsmt-id ` がマウントターゲット ID で、` fs-id ` が `FileSystemId` である記述 `Mount target fsmt-id for file system fs-id `。
+ `requesterManaged` プロパティが `true` に、`requesterId` 値が `EFS` に設定されているネットワークインターフェイス。
各マウントターゲットには、対応するリクエスタマネージド型の EC2 ネットワークインターフェイスが 1 つあります。ネットワークインターフェイスが作成されると、Amazon EFS はマウントターゲットの説明の `NetworkInterfaceId` フィールドをネットワークインターフェイス ID に設定し、IP アドレスをそのアドレスに設定します。ネットワークインターフェイスの作成に失敗すると、`CreateMountTarget` オペレーション全体が失敗します。
**注記**
`CreateMountTarget` コールは、ネットワークインターフェイスを作成した後で、マウントターゲットの状態が `creating` のままの場合にのみ返されます。[DescribeMountTargets](API_DescribeMountTargets.md) オペレーションをコールすることでマウントターゲットの作成ステータスをチェックできます。これにより、マウントターゲットの状態が返されます。
このオペレーションには、ファイルシステムに対する次のアクションに対するアクセス許可が必要です。
+ `elasticfilesystem:CreateMountTarget`
このオペレーションには、次の Amazon EC2 アクションに対するアクセス許可も必要です。
+ `ec2:DescribeSubnets`
+ `ec2:DescribeNetworkInterfaces`
+ `ec2:CreateNetworkInterface`
## リクエストの構文
```
POST /2015-02-01/mount-targets HTTP/1.1
Content-type: application/json
{
"FileSystemId": "string",
"IpAddress": "string",
"IpAddressType": "string",
"Ipv6Address": "string",
"SecurityGroups": [ "string" ],
"SubnetId": "string"
}
```
## URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [FileSystemId](#API_CreateMountTarget_RequestSyntax) **
マウントターゲットを作成するファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** [IpAddress](#API_CreateMountTarget_RequestSyntax) **
マウントターゲットの `IpAddressType` が IPv4 (`IPV4_ONLY` または `DUAL_STACK`) の場合は、使用する IPv4 アドレスを指定します。`IpAddress` を指定しない場合、Amazon EFS は `SubnetId` に指定されたサブネットから未使用の IP アドレスを選択します。
タイプ: 文字列
長さの制限: 最小長は 7 です。最大長は 15 です。
パターン: `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$`
必須: いいえ
** [IpAddressType](#API_CreateMountTarget_RequestSyntax) **
マウントターゲットの IP アドレスタイプ。指定できる値は、`IPV4_ONLY` (IPv4 アドレスのみ）、`IPV6_ONLY` (IPv6 アドレスのみ）、`DUAL_STACK` (デュアルスタック、IPv4 アドレスと IPv6 アドレスの両方) です。`IpAddressType` を指定しない場合、`IPV4_ONLY` が使用されます。
`IPAddressType` は、サブネットの IP タイプと一致する必要があります。さらに、`IPAddressType` パラメータは、VPC 内のサブネットのデフォルト IP アドレスとして設定された値を上書きします。例えば、`IPAddressType` が `IPV4_ONLY` で、`AssignIpv6AddressOnCreation` が `true` の場合、IPv4 がマウントターゲットに使用されます。詳細については「[サブネットの IP アドレス指定属性を変更する](https://docs.aws.amazon.com/vpc/latest/userguide/subnet-public-ip.html)」を参照してください。
型: 文字列
有効な値：`IPV4_ONLY | IPV6_ONLY | DUAL_STACK`
必須：いいえ
** [Ipv6Address](#API_CreateMountTarget_RequestSyntax) **
マウントターゲットの `IPAddressType` が IPv6 (`IPV6_ONLY` または `DUAL_STACK`) の場合は、使用する IPv6 アドレスを指定します。`Ipv6Address` を指定しない場合、Amazon EFS は `SubnetId` に指定されたサブネットから未使用の IP アドレスを選択します。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 39 です。
必須: いいえ
** [SecurityGroups](#API_CreateMountTarget_RequestSyntax) **
`sg-xxxxxxxx` の形式 VPC セキュリティグループ ID。これらは指定されたサブネットと同じ VPC 用である必要があります。セキュリティグループの最大数は、アカウントクォータによって異なります。詳細については、「*Amazon VPC ユーザーガイド*」の「[Amazon VPC クォータ](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html)」内の**セキュリティグループ**の表を参照してください。セキュリティグループを指定しない場合、Amazon EFS はサブネットの VPC のデフォルトのセキュリティグループを使用します。
型: 文字列の配列
配列メンバー: 最大数は 100 項目です。
長さの制限: 最小長は 11 です。最大長は 43 です。
パターン: `^sg-[0-9a-f]{8,40}`
必須: いいえ
** [SubnetId](#API_CreateMountTarget_RequestSyntax) **
マウントターゲットを追加するサブネットの ID。1 ゾーンファイルシステムの場合は、ファイルシステムのアベイラビリティーゾーンに関連付けられたサブネットを使用します。サブネットタイプは、`IpAddressType` と同じタイプである必要があります。
タイプ: 文字列
長さの制限: 最小長は 15 です。最大長は 47 です。
パターン: `^subnet-[0-9a-f]{8,40}$`
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"AvailabilityZoneId": "string",
"AvailabilityZoneName": "string",
"FileSystemId": "string",
"IpAddress": "string",
"Ipv6Address": "string",
"LifeCycleState": "string",
"MountTargetId": "string",
"NetworkInterfaceId": "string",
"OwnerId": "string",
"SubnetId": "string",
"VpcId": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AvailabilityZoneId](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットが存在するアベイラビリティーゾーンの一意で一貫性のある識別子。たとえば、 `use1-az1`は us-east-1 リージョンの AZ ID であり、すべての に同じ場所があります AWS アカウント。
タイプ: 文字列
** [AvailabilityZoneName](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットが配置されているアベイラビリティーゾーンの名前。アベイラビリティーゾーンは、それぞれの名前に個別にマッピングされます AWS アカウント。たとえば、 `us-east-1a`のアベイラビリティーゾーンが別の のアベイラビリティ`us-east-1a`ーゾーンと同じ場所ではない AWS アカウント 場合があります AWS アカウント。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [FileSystemId](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットが意図されているファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [IpAddress](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットの IPv4 アドレス。
タイプ: 文字列
長さの制限: 最小長は 7 です。最大長は 15 です。
パターン: `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$`
** [Ipv6Address](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットの IPv6 アドレス。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 39 です。
** [LifeCycleState](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットのライフサイクル状態。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
** [MountTargetId](#API_CreateMountTarget_ResponseSyntax) **
システム割り当てマウントターゲット ID。
タイプ: 文字列
長さの制限: 最小長は 13 です。最大長は 45 です。
パターン: `^fsmt-[0-9a-f]{8,40}$`
** [NetworkInterfaceId](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットを作成したときに Amazon EFS が作成したネットワークインターフェイスの ID。
タイプ: 文字列
** [OwnerId](#API_CreateMountTarget_ResponseSyntax) **
AWS アカウント リソースを所有する ID。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
** [SubnetId](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットのサブネットの ID。
タイプ: 文字列
長さの制限: 最小長は 15 です。最大長は 47 です。
パターン: `^subnet-[0-9a-f]{8,40}$`
** [VpcId](#API_CreateMountTarget_ResponseSyntax) **
マウントターゲットが設定されている 仮想プライベートクラウド (VPC) ID。
タイプ: 文字列
## エラー
** AvailabilityZonesMismatch **
マウントターゲットに指定されたアベイラビリティーゾーンが、ファイルシステムのアベイラビリティーゾーンと異なる場合に返されます。詳細については、「[リージョナルと 1 ゾーンのストレージの冗長性](https://docs.aws.amazon.com/efs/latest/ug/accessing-fs)」を参照してください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** IpAddressInUse **
サブネット内で既に使用されている IP アドレス (`IpAddress` または `Ipv6Address`) をリクエストで指定した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** MountTargetConflict **
ファイルシステムの既存のマウントターゲットに基づいて、マウントターゲットが指定された制限のいずれかに違反した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** NetworkInterfaceLimitExceeded **
通話アカウントが、特定の AWS リージョンの Elastic Network Interface の制限に達しました。一部のネットワークインターフェースを削除するか、アカウントクォータの引き上げをリクエストしてください。詳細については、「*Amazon VPC ユーザーガイド*」の「[Amazon VPC クォータ](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html)」を参照してください (**ネットワークインターフェイス**の表にある「**リージョンごとのネットワークインターフェイス**」を参照)。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** NoFreeAddressesInSubnet **
リクエストに `IpAddress` または `Ipv6Address` が含まれておらず、指定されたサブネット内に空き IP アドレスがない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** SecurityGroupLimitExceeded **
リクエストで指定された `SecurityGroups` の数が、アカウントクォータに基づく制限より大きい場合に返されます。いくつかのセキュリティグループを削除するか、アカウントクォータの引き上げをリクエストしてください。詳細については、「*Amazon VPC ユーザーガイド*」の「[Amazon VPC クォータ](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html)」内の**セキュリティグループ**の表を参照してください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** SecurityGroupNotFound **
指定したセキュリティグループの 1 つがサブネットの仮想プライベートクラウド (VPC) に存在しない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** SubnetNotFound **
リクエストで提供された ID `SubnetId` のサブネットが存在しない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** UnsupportedAvailabilityZone **
リクエストされた Amazon EFS 機能が指定されたアベイラビリティーゾーンで利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 例
### サブネットで使用可能な IPv4 アドレスでマウントターゲットを作成する
次のリクエストは、マウントターゲットのファイルシステムとサブネットのみを指定します。ターゲットは、指定されたサブネットで使用可能な IPv4 アドレスで作成され、デフォルトのセキュリティグループが VPC に関連付けられます。
#### リクエスト例
```
POST /2015-02-01/mount-targets HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{"SubnetId": "subnet-748c5d03", "FileSystemId": "fs-01234567"}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 252
{
"OwnerId": "231243201240",
"MountTargetId": "fsmt-55a4413c",
"FileSystemId": "fs-01234567",
"SubnetId": "subnet-01234567",
"LifeCycleState": "available",
"IpAddress": "172.31.22.183"
"NetworkInterfaceId":"eni-1bcb7772"
"AvailabilityZoneId": "eus1-az2",
"AvailabilityZoneName": "eu-south-1b",
"VpcId": "vpc-08d45b31fa009a15e"
}
```
### 特定の IPv4 アドレスでマウントターゲットを作成する
次のリクエストは、マウントターゲットのファイルシステム、サブネット、セキュリティグループ、および使用する IPv4 アドレスを指定します。
#### リクエスト例
```
POST /2015-02-01/mount-targets HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-01234567",
"IpAddress":"10.0.2.42",
"SecurityGroups":[
"sg-01234567"
]
}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 252
{
"OwnerId":"251839141158",
"MountTargetId":"fsmt-9a13661e",
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-fd04ff94",
"LifeCycleState":"available",
"IpAddress":"10.0.2.42",
"NetworkInterfaceId":"eni-1bcb7772"
"AvailabilityZoneId": "eus1-az2",
"AvailabilityZoneName": "eu-south-1b",
"VpcId": "vpc-08d45b31fa009a15e"
}
```
### 特定の IPv6 アドレスでマウントターゲットを作成する
次のリクエストは、マウントターゲットのファイルシステム、サブネット、セキュリティグループ、および使用する IPv6 アドレスを指定します。
#### リクエスト例
```
POST /2015-02-01/mount-targets HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-01234567",
"Ipv6Address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"IpAddressType": "IPV6_ONLY",
"SecurityGroups":[
"sg-01234567"
]
}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 252
{
"OwnerId":"251839141158",
"MountTargetId":"fsmt-9a13661e",
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-fd04ff94",
"LifeCycleState":"available",
"Ipv6Address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"NetworkInterfaceId":"eni-1bcb7772"
"AvailabilityZoneId": "eus1-az2",
"AvailabilityZoneName": "eu-south-1b",
"VpcId": "vpc-08d45b31fa009a15e"
}
```
### デュアルスタックサブネットで使用可能な IPv4 アドレスでマウントターゲットを作成する
次のリクエストは、マウントターゲットのファイルシステム、サブネット、アドレスタイプを指定します。ターゲットは、指定されたデュアルスタックサブネットで使用可能な IPv4 アドレスで作成され、デフォルトのセキュリティグループが VPC に関連付けられます。
#### リクエスト例
```
POST /2015-02-01/mount-targets HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{"SubnetId": "subnet-748c5d03", "FileSystemId": "fs-01234567"}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 252
{
"OwnerId": "251839141158",
"MountTargetId": "fsmt-55a4413c",
"FileSystemId": "fs-01234567",
"SubnetId":"subnet-fd04ff94",
"LifeCycleState": "available",
"IpAddress": "172.31.22.183"
"Ipv6Address": "2a05:d01a:419:8611:3e57:75ab:5719:b238",
"NetworkInterfaceId": "eni-01234567",
"AvailabilityZoneId": "eus1-az2",
"AvailabilityZoneName": "eu-south-1b",
"VpcId": "vpc-08d45b31fa009a15e"
}
```
### デュアルスタックサブネット上の特定の IPv4 アドレスと IPv6 アドレスにマウントターゲットを作成する
次のリクエストは、マウントターゲットのファイルシステム、サブネット、セキュリティグループ、IPv4 アドレス、および IPv6 アドレスを指定します。ターゲットは、デュアルスタックサブネットの指定された IPv4 アドレスと IPv6 アドレスで作成されます。
#### リクエスト例
```
POST /2015-02-01/mount-targets HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-01234567",
"IpAddressType": "DUAL_STACK",
"IpAddress": "10.0.1.25",
"Ipv6Address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"SecurityGroups":[
"sg-01234567"
]
}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 252
{
"OwnerId": "231243201240",
"MountTargetId": "fsmt-55a4413c",
"FileSystemId": "fs-01234567",
"SubnetId": "subnet-01234567",
"LifeCycleState": "available",
"IpAddress": "10.0.1.25",
"Ipv6Address":"2001:0db8:85a3:0000:0000:8a2e:0370:7334",
"NetworkInterfaceId": "eni-01234567",
"AvailabilityZoneId": "eus1-az2",
"AvailabilityZoneName": "eu-south-1b",
"VpcId": "vpc-08d45b31fa009a15e"
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/CreateMountTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreateMountTarget)
# CreateReplicationConfiguration
新規または既存の EFS ファイルシステムにレプリケーション設定を作成します。詳細については、「*Amazon EFS ユーザーガイド*」の「[Amazon EFS レプリケーション](https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html)」を参照してください。レプリケーション設定では、以下を指定します。
+ **ソースファイルシステム** - レプリケートする EFS ファイルシステム。
+ **送信先ファイルシステム** – ソースファイルシステムがレプリケートされる送信先ファイルシステム。1 つのレプリケーション設定にはデスティネーションファイルシステムは 1 つしか存在できません。
**注記**
ファイルシステムは、1 つのレプリケーション設定にのみ含めることができます。
レプリケーション設定の送信先パラメータは、新しいファイルシステムまたは既存のファイルシステムにレプリケートするかどうか、および AWS アカウント間でレプリケートするかどうかによって異なります。詳細については「[DestinationToCreate](API_DestinationToCreate.md)」を参照してください。
このオペレーションには、`elasticfilesystem:CreateReplicationConfiguration` アクションに対するアクセス許可が必要です。さらに、ファイルシステムのレプリケーション方法に応じて、他のアクセス許可が必要です。詳細については、「*Amazon EFS ユーザーガイド*」の「[レプリケートに必要なアクセス許可](https://docs.aws.amazon.com/efs/latest/ug/efs-replication.html#efs-replication-permissions)」を参照してください。
## リクエストの構文
```
POST /2015-02-01/file-systems/SourceFileSystemId/replication-configuration HTTP/1.1
Content-type: application/json
{
"Destinations": [
{
"AvailabilityZoneName": "string",
"FileSystemId": "string",
"KmsKeyId": "string",
"Region": "string",
"RoleArn": "string"
}
]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [SourceFileSystemId](#API_CreateReplicationConfiguration_RequestSyntax) **
レプリケートする Amazon EFS ファイルシステムを指定します。このファイルシステムは、別のレプリケーション設定で既にソースまたはデスティネーションファイルシステムになっていることはできません。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [Destinations](#API_CreateReplicationConfiguration_RequestSyntax) **
送信先設定オブジェクトの配列です。サポートされるデスティネーション設定オブジェクトは 1 つだけです。
型: [DestinationToCreate](API_DestinationToCreate.md) オブジェクトの配列
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"CreationTime": number,
"Destinations": [
{
"FileSystemId": "string",
"LastReplicatedTimestamp": number,
"OwnerId": "string",
"Region": "string",
"RoleArn": "string",
"Status": "string",
"StatusMessage": "string"
}
],
"OriginalSourceFileSystemArn": "string",
"SourceFileSystemArn": "string",
"SourceFileSystemId": "string",
"SourceFileSystemOwnerId": "string",
"SourceFileSystemRegion": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [CreationTime](#API_CreateReplicationConfiguration_ResponseSyntax) **
レプリケーション設定の作成日を記述します。
タイプ: タイムスタンプ
** [Destinations](#API_CreateReplicationConfiguration_ResponseSyntax) **
送信先オブジェクトの配列。サポートされているデスティネーションオブジェクトは 1 つだけです。
型: [Destination](API_Destination.md) オブジェクトの配列
** [OriginalSourceFileSystemArn](#API_CreateReplicationConfiguration_ResponseSyntax) **
レプリケーション設定の元のソース EFS ファイルシステムの Amazon リソースネーム (ARN)。
タイプ: 文字列
** [SourceFileSystemArn](#API_CreateReplicationConfiguration_ResponseSyntax) **
レプリケーション設定内の現在のソースファイルシステムの Amazon リソースネーム (ARN)。
タイプ: 文字列
** [SourceFileSystemId](#API_CreateReplicationConfiguration_ResponseSyntax) **
レプリケートされたソースの Amazon EFS ファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [SourceFileSystemOwnerId](#API_CreateReplicationConfiguration_ResponseSyntax) **
AWS アカウント ソースファイルシステムが存在する の ID。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
** [SourceFileSystemRegion](#API_CreateReplicationConfiguration_ResponseSyntax) **
ソース EFS ファイルシステム AWS リージョン がある 。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** ConflictException **
レプリケーションのソースファイルシステムが暗号化されている一方で、デスティネーションファイルシステムが暗号化されていない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** FileSystemLimitExceeded **
AWS アカウント がアカウントごとに許可されるファイルシステムの最大数を既に作成している場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 403
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InsufficientThroughputCapacity **
追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後でもう一度お試しください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 503
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ReplicationNotFound **
指定したファイルシステムにレプリケーション設定がない場合に返されます。
** ErrorCode **
ReplicationNotFound
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** ThroughputLimitExceeded **
スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** UnsupportedAvailabilityZone **
リクエストされた Amazon EFS 機能が指定されたアベイラビリティーゾーンで利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** ValidationException **
リクエストが行われた AWS リージョン で AWS Backup サービスが利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreateReplicationConfiguration)
# CreateTags
**注記**
非推奨 - `CreateTags` は非推奨であり、維持されません。EFS リソースのタグを作成するには、[TagResource](API_TagResource.md) の API アクションを使用します。
ファイルシステムに関連付けられたタグを作成または上書きします。各タグはキーバリューのペアです。リクエストで指定されたタグキーがファイルシステム上にすでに存在する場合、このオペレーションは、リクエストで指定された値でその値を上書きします。`Name` のタグをファイルシステムに追加すると、Amazon EFS は [DescribeFileSystems](API_DescribeFileSystems.md)のオペレーションに対する応答でタグを返します。
このオペレーションには `elasticfilesystem:CreateTags` アクションに対するアクセス許可が必要です。
## リクエストの構文
```
POST /2015-02-01/create-tags/FileSystemId HTTP/1.1
Content-type: application/json
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_CreateTags_RequestSyntax) **
変更するタグが付けられたファイルシステムの ID (文字列)。このオペレーションでは、ファイルシステムは変更されず、タグのみが変更されます。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [Tags](#API_CreateTags_RequestSyntax) **
追加する `Tag` オブジェクトの配列。各 `Tag` オブジェクトタグはキーバリューのペアです。
型: [Tag](API_Tag.md) オブジェクトの配列
必須: はい
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/CreateTags)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreateTags)
# DeleteAccessPoint
指定されたアクセスポイントを削除します。削除が完了すると、新しいクライアントはアクセスポイントに接続できなくなります。削除時にアクセスポイントに接続されたクライアントは、接続を終了するまで引き続き機能します。
このオペレーションには、`elasticfilesystem:DeleteAccessPoint` アクションに対する許可が必要です。
## リクエストの構文
```
DELETE /2015-02-01/access-points/AccessPointId HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [AccessPointId](#API_DeleteAccessPoint_RequestSyntax) **
削除するアクセスポイントの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteAccessPoint)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteAccessPoint)
# DeleteFileSystem
ファイルシステムを削除し、その内容へのアクセスを永久に切断します。戻ると、ファイルシステムは存在しなくなり、削除されたファイルシステムのコンテンツにアクセスできなくなります。
EFS ファイルシステムを削除する前に、ファイルシステムに接続されているマウントターゲットを手動で削除する必要があります。このステップは、 AWS コンソールを使用してファイルシステムを削除するときに自動的に実行されます。
**注記**
EFS レプリケーション設定の一部であるファイルシステムを削除することはできません。レプリケーション設定を最初に削除する必要があります。
使用中のファイルシステムを削除することはできません。つまり、ファイルシステムにマウントターゲットがある場合は、まずマウントターゲットを削除する必要があります。詳細については、「[DescribeMountTargets](API_DescribeMountTargets.md)」および「[DeleteMountTarget](API_DeleteMountTarget.md)」を参照してください。
**注記**
`DeleteFileSystem` コールは、ファイルシステムの状態がまだ `deleting` である間に戻ります。ファイルシステムの削除状況をチェックするには、アカウント内のファイルシステムのリストを返す [DescribeFileSystems](API_DescribeFileSystems.md) オペレーションをコールします。削除されたファイルシステムのファイルシステム ID または作成 トークンを渡した場合、[DescribeFileSystems](API_DescribeFileSystems.md) は `404 FileSystemNotFound` のエラーを返します。
このオペレーションには、`elasticfilesystem:DeleteFileSystem` アクションに対する許可が必要です。
## リクエストの構文
```
DELETE /2015-02-01/file-systems/FileSystemId HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DeleteFileSystem_RequestSyntax) **
削除するファイルシステムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemInUse **
ファイルシステムに、マウントターゲットがある場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### ファイルシステムの削除
次の例では、`file-systems` エンドポイント（`elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems/fs-01234567`）に DELETE リクエストを送信して、ID が `fs-01234567` のファイルシステムを削除します。
#### リクエスト例
```
DELETE /2015-02-01/file-systems/fs-01234567 HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140622T233021Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 204 No Content
x-amzn-RequestId: a2d125b3-7ebd-4d6a-ab3d-5548630bff33
Content-Length: 0
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteFileSystem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteFileSystem)
# DeleteFileSystemPolicy
指定されたファイルシステムの `FileSystemPolicy` を削除します。既存のポリシーが削除されると、デフォルトの `FileSystemPolicy` が有効になります。デフォルトのファイル システムポリシーの詳細については、「[EFS でリソースベースのポリシーを使用する](https://docs.aws.amazon.com/efs/latest/ug/res-based-policies-efs.html)」を参照してください。
このオペレーションには、`elasticfilesystem:DeleteFileSystemPolicy` アクションに対する許可が必要です。
## リクエストの構文
```
DELETE /2015-02-01/file-systems/FileSystemId/policy HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DeleteFileSystemPolicy_RequestSyntax) **
`FileSystemPolicy` を削除する EFS ファイルシステムを指定します。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteFileSystemPolicy)
# DeleteMountTarget
指定されたマウントターゲットを削除します。
このオペレーションにより、削除されるマウントターゲットを使用しているファイルシステムのマウントが強制的に解除されるため、そのマウントを使用しているインスタンスやアプリケーションが停止する可能性があります。アプリケーションが突然切断されないように、可能であれば、マウントターゲットのマウントをすべてアンマウントすることを検討してください。このオペレーションにより、関連付けられたネットワークインターフェイスも削除されます。コミットされていない書き込みは失われる可能性がありますが、このオペレーションを使用してマウント・ターゲットを破っても、ファイル・システム自体が破損することはありません。作成したファイルシステムは残ります。別のマウントターゲットを使用して VPC に EC2 インスタンスをマウントできます。
このオペレーションには、ファイルシステムに対する次のアクションに対するアクセス許可が必要です。
+ `elasticfilesystem:DeleteMountTarget`
**注記**
マウントターゲットの状態がまだ `deleting` にある間に `DeleteMountTarget` コールが戻ります。マウントターゲットの削除をチェックするには、指定されたファイルシステムのマウントターゲットの説明のリストを返す [DescribeMountTargets](API_DescribeMountTargets.md) オペレーションをコールします。
オペレーションには、マウントターゲットのネットワーク インターフェイスで次の Amazon EC2 アクションに対するアクセス許可も必要です。
+ `ec2:DeleteNetworkInterface`
## リクエストの構文
```
DELETE /2015-02-01/mount-targets/MountTargetId HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [MountTargetId](#API_DeleteMountTarget_RequestSyntax) **
削除するマウントターゲットの ID (文字列)。
長さの制限: 最小長は 13 です。最大長は 45 です。
パターン: `^fsmt-[0-9a-f]{8,40}$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** DependencyTimeout **
リクエストを履行しようとしてサービスがタイムアウトしたため、クライアントはコールを再試行する必要があります。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 504
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** MountTargetNotFound **
指定された ID のマウントターゲットが発信者の AWS アカウントで見つからない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
## 例
### ファイルシステムのマウントターゲットの削除
次の例では、DELETE リクエストを送信して、特定のマウントターゲットを削除します。
#### リクエスト例
```
DELETE /2015-02-01/mount-targets/fsmt-9a13661e HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140622T232908Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 204 No Content
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteMountTarget)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteMountTarget)
# DeleteReplicationConfiguration
レプリケーション設定を削除する。レプリケーション設定を削除すると、レプリケーションプロセスは終了します。レプリケーション設定が削除されると、デスティネーションファイルシステムが `Writeable` となり、そのレプリケーション上書き保護が再び有効になります。詳細については、「[レプリケーション設定の削除](https://docs.aws.amazon.com/efs/latest/ug/delete-replications.html)」を参照してください。
このオペレーションには、`elasticfilesystem:DeleteReplicationConfiguration` アクションに対する許可が必要です。
## リクエストの構文
```
DELETE /2015-02-01/file-systems/SourceFileSystemId/replication-configuration?deletionMode=DeletionMode HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [DeletionMode](#API_DeleteReplicationConfiguration_RequestSyntax) **
Amazon EFS は AWS リージョン、レプリケート元アカウントとレプリケート先アカウント AWS アカウント またはリージョン (`ALL_CONFIGURATIONS`) の両方からレプリケーション設定をデフォルトで削除します。Amazon EFS がレプリケーション設定を両方から削除できない設定またはアクセス許可の問題がある場合は、ユーザーは `LOCAL_CONFIGURATION_ONLY` モードを使用して、ローカル側 (削除が実行されるアカウントまたはリージョン) からのみレプリケーション設定を削除できます。
Amazon EFS がソースアカウントと送信先アカウントまたはリージョンの両方でレプリケーション設定を削除できない場合のみ、`LOCAL_CONFIGURATION_ONLY` モードを使用します。ローカル設定を削除すると、他のアカウントまたはリージョンの設定は回復できなくなります。
さらに、同じアカウント、同じリージョンのレプリケーションにこのモードを使用しないでください。使用した場合、BadRequest 例外エラーが発生します。
有効な値：`ALL_CONFIGURATIONS | LOCAL_CONFIGURATION_ONLY`
** [SourceFileSystemId](#API_DeleteReplicationConfiguration_RequestSyntax) **
レプリケーション設定内のソースファイルシステムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ReplicationNotFound **
指定したファイルシステムにレプリケーション設定がない場合に返されます。
** ErrorCode **
ReplicationNotFound
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteReplicationConfiguration)
# DeleteTags
**注記**
非推奨 - `DeleteTags` は非推奨であり、維持されません。EFS リソースからタグを削除するには、[UntagResource](API_UntagResource.md) API アクションを使用します。
ファイルシステムから指定されたタグを削除します。`DeleteTags` のリクエストに存在しないタグキーが含まれていても、Amazon EFS はそれを無視し、エラーを起こしません。タグおよび関連する制限の詳細については、「 * AWS Billing and Cost Management ユーザーガイド*」の[「タグの制限](https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html)」を参照してください。
このオペレーションには、`elasticfilesystem:DeleteTags` アクションに対する許可が必要です。
## リクエストの構文
```
POST /2015-02-01/delete-tags/FileSystemId HTTP/1.1
Content-type: application/json
{
"TagKeys": [ "string" ]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DeleteTags_RequestSyntax) **
削除するタグが付けられたファイルシステムの ID (文字列)。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [TagKeys](#API_DeleteTags_RequestSyntax) **
削除するタグキーのリスト。
型: 文字列の配列
配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。
長さの制限：最小長 1、最大長は 128 です。
パターン: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`
必須: はい
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DeleteTags)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DeleteTags)
# DescribeAccessPoints
`AccessPointId` が提供されている場合、特定の Amazon EFS アクセスポイントの説明を返します。EFS `FileSystemId` を指定すると、そのファイルシステムのすべてのアクセスポイントの説明が返されます。リクエストには、`AccessPointId` または `FileSystemId` のどちらかを指定できますが、両方を指定することはできません。
このオペレーションには、`elasticfilesystem:DescribeAccessPoints` アクションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/access-points?AccessPointId=AccessPointId&FileSystemId=FileSystemId&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [AccessPointId](#API_DescribeAccessPoints_RequestSyntax) **
（オプション）応答で記述するEFSアクセスポイントを指定します。`FileSystemId` とは相互に排他的です。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`
** [FileSystemId](#API_DescribeAccessPoints_RequestSyntax) **
(オプション)`FileSystemId`の場合、EFS はそのファイルシステムのすべてのアクセスポイントを返します。`AccessPointId` とは相互に排他的です。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [MaxResults](#API_DescribeAccessPoints_RequestSyntax) **
(オプション）ファイルシステムのすべてのアクセスポイントを取得する際に、オプションで `MaxItems` パラメータを指定して、応答で返されるオブジェクトの数を制限することができます。デフォルト値は 100 です。
有効な範囲: 最小値 は 1 です。
** [NextToken](#API_DescribeAccessPoints_RequestSyntax) **
`NextToken` は応答がページ割りされている場合に存在します。後続のリクエストで `NextMarker` を使うと、次のページのアクセスポイントの説明を取得することができます。
長さの制限：最小長 1、最大長は 128 です。
Pattern: `.+`
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"AccessPoints": [
{
"AccessPointArn": "string",
"AccessPointId": "string",
"ClientToken": "string",
"FileSystemId": "string",
"LifeCycleState": "string",
"Name": "string",
"OwnerId": "string",
"PosixUser": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"RootDirectory": {
"CreationInfo": {
"OwnerGid": number,
"OwnerUid": number,
"Permissions": "string"
},
"Path": "string"
},
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
],
"NextToken": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [AccessPoints](#API_DescribeAccessPoints_ResponseSyntax) **
アクセスポイントの説明の配列。
型: [AccessPointDescription](API_AccessPointDescription.md) オブジェクトの配列
** [NextToken](#API_DescribeAccessPoints_ResponseSyntax) **
応答で返されるよりも多くのアクセスポイントがある場合に表示されます。後続のリクエストで NextMarker を使用して、追加の説明をフェッチできます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeAccessPoints)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeAccessPoints)
# DescribeAccountPreferences
現在の で、リクエストを行うユーザー AWS アカウント に関連付けられた のアカウント設定を返します AWS リージョン。
## リクエストの構文
```
GET /2015-02-01/account-preferences HTTP/1.1
Content-type: application/json
{
"MaxResults": number,
"NextToken": "string"
}
```
## URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [MaxResults](#API_DescribeAccountPreferences_RequestSyntax) **
(オプション) アカウントの設定を取得する際に、オプションで `MaxItems` パラメータを指定して、レスポンスで返されるオブジェクトの数を制限することができます。デフォルト値は 100 です。
型: 整数
有効な範囲: 最小値 は 1 です。
必須: いいえ
** [NextToken](#API_DescribeAccountPreferences_RequestSyntax) **
(オプション）レスポンスのペイロードがページ割りされている場合、次のリクエストで `NextToken` を使用すると、 AWS アカウント のプリファレンスの次のページをフェッチできます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
必須: いいえ
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"ResourceIdPreference": {
"ResourceIdType": "string",
"Resources": [ "string" ]
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_DescribeAccountPreferences_ResponseSyntax) **
応答で返されるよりも多くのレコードがある場合に表示されます。後続のリクエストで `NextToken` を使うと、追加の説明をフェッチすることができます。
型: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [ResourceIdPreference](#API_DescribeAccountPreferences_ResponseSyntax) **
現在の で、リクエストを行うユーザー AWS アカウント に関連付けられた のリソース ID 設定について説明します AWS リージョン。
型: [ResourceIdPreference](API_ResourceIdPreference.md) オブジェクト
## エラー
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeAccountPreferences)
# DescribeBackupPolicy
指定された EFS ファイルシステムのバックアップポリシーを返します。
## リクエストの構文
```
GET /2015-02-01/file-systems/FileSystemId/backup-policy HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DescribeBackupPolicy_RequestSyntax) **
`BackupPolicy` を取得する EFS ファイルシステムを指定します。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPolicy": {
"Status": "string"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [BackupPolicy](#API_DescribeBackupPolicy_ResponseSyntax) **
ファイルシステムのバックアップポリシーについて説明し、自動バックアップをオンにするかオフにするかを示します。
型: [BackupPolicy](API_BackupPolicy.md) オブジェクト
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** PolicyNotFound **
指定された IAM ポリシーまたはリソースポリシーが配置またはアクセスできない場合に返されます。実行されるアクションによっては、EFS ファイルシステムに対してデフォルトのファイルシステムポリシーが有効な場合、またはバックアップポリシーが指定されていない場合にも、このエラーが返されることがあります。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** ValidationException **
リクエストが行われた AWS リージョン で AWS Backup サービスが利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeBackupPolicy)
# DescribeFileSystemPolicy
指定されたEFSファイルシステムの `FileSystemPolicy` を返します。
このオペレーションには、`elasticfilesystem:DescribeFileSystemPolicy` アクションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/file-systems/FileSystemId/policy HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DescribeFileSystemPolicy_RequestSyntax) **
`FileSystemPolicy` を取得するEFSファイルシステムを指定します。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"FileSystemId": "string",
"Policy": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [FileSystemId](#API_DescribeFileSystemPolicy_ResponseSyntax) **
`FileSystemPolicy` が適用される EFS ファイルシステムを指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [Policy](#API_DescribeFileSystemPolicy_ResponseSyntax) **
EFS ファイルシステムの JSON 形式の `FileSystemPolicy` です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 20000 です。
パターン: `[\s\S]+`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** PolicyNotFound **
指定された IAM ポリシーまたはリソースポリシーが配置またはアクセスできない場合に返されます。実行されるアクションによっては、EFS ファイルシステムに対してデフォルトのファイルシステムポリシーが有効な場合、またはバックアップポリシーが指定されていない場合にも、このエラーが返されることがあります。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
## 例
### 例
この例では、DescribeFileSystemPolicy の 1 つの使用方法について説明します。
#### リクエスト例
```
GET /2015-02-01/file-systems/fs-01234567/policy HTTP/1.1
```
#### レスポンス例
```
{
"FileSystemId": "fs-01234567",
"Policy": "{
"Version": "2012-10-17",
"Id": "efs-policy-wizard-cdef0123-aaaa-6666-5555-444455556666",
"Statement": [
{
"Sid": "efs-statement-abcdef01-1111-bbbb-2222-111122224444",
"Effect" : "Deny",
"Principal": {
"AWS": "*"
},
"Action": "*",
"Resource": "arn:aws:elasticfilesystem:us-east-2:111122223333:file-system/fs-01234567",
"Condition": {
"Bool": {
"aws:SecureTransport": "false"
}
}
},
{
"Sid": "efs-statement-01234567-aaaa-3333-4444-111122223333",
"Effect": "Allow",
"Principal": {
"AWS": "*"
},
"Action": [
"elasticfilesystem:ClientMount",
"elasticfilesystem:ClientWrite"
],
"Resource" : "arn:aws:elasticfilesystem:us-east-2:111122223333:file-system/fs-01234567"
}
]
}
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeFileSystemPolicy)
# DescribeFileSystems
ファイルシステム `CreationToken` またはファイルシステム `FileSystemId` のいずれかが提供された場合、特定の Amazon EFS ファイルシステムの説明を返します。それ以外の場合は、呼び出しているエンドポイント AWS リージョン の AWS アカウント で、呼び出し元の が所有するすべてのファイルシステムの説明を返します。
すべてのファイルシステムの説明を取得する際に、オプションで `MaxItems` パラメータを指定して、応答に含まれる説明の数を制限することができます。この数値は自動的に 100 に設定されます。より多くのファイルシステムの説明が残っている場合、Amazon EFS は応答で不透明な トークンである `NextMarker` を返します。この場合、`Marker` リクエストのパラメーターを `NextMarker` の値に設定して、次のリクエストを送信する必要があります。
ファイルシステムの説明の一覧を取得するために、このオペレーションは反復プロセスで使用されます。ここでは、`DescribeFileSystems` が `Marker` なしで最初にコールされ、`Marker` パラメータが前の応答の `NextMarker` の値に設定された状態で、応答に `NextMarker` がなくなるまで、オペレーションはコールし続けます。
1回の `DescribeFileSystems` コールの応答で返されるファイルシステムの順序と、複数回コールの反復の応答全体で返されるファイルシステムの順序は、指定されていません。
このオペレーションには、`elasticfilesystem:DescribeFileSystems` アクションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/file-systems?CreationToken=CreationToken&FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [CreationToken](#API_DescribeFileSystems_RequestSyntax) **
(オプション) リストを、この作成トークン(文字列)を持つファイルシステムに制限します。作成 トークンは、Amazon EFS ファイルシステムを作成するときに指定します。
長さの制限：最小長 1、最大長 64
パターン: `.+`
** [FileSystemId](#API_DescribeFileSystems_RequestSyntax) **
（オプション）説明を取得するファイルシステムの ID（文字列）。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [Marker](#API_DescribeFileSystems_RequestSyntax) **
(オプション) 前の `DescribeFileSystems` オペレーション (文字列)から返された不透明なページ割りトークン。存在する場合は、返すコールが中断された場所からリストを続行するように指定します。
長さの制限：最小長 1、最大長は 128 です。
パターン: `.+`
** [MaxItems](#API_DescribeFileSystems_RequestSyntax) **
（オプション）レスポンスで返すファイルシステムの最大数を指定します（整数）。この数値は自動的に 100 に設定されます。100 を超えるファイルシステムがある場合、応答はページあたり 100 でページ割りされます。
有効な範囲: 最小値 は 1 です。
## リクエスト本文
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"FileSystems": [
{
"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"
}
],
"Marker": "string",
"NextMarker": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [FileSystems](#API_DescribeFileSystems_ResponseSyntax) **
ファイルシステムの説明の配列。
型: [FileSystemDescription](API_FileSystemDescription.md) オブジェクトの配列
** [Marker](#API_DescribeFileSystems_ResponseSyntax) **
リクエストで発信者から提供された場合に存在します (文字列)。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [NextMarker](#API_DescribeFileSystems_ResponseSyntax) **
応答で返されたファイルシステムよりも多くのファイルシステムがある場合に表示されます (文字列)。後続のリクエストで `NextMarker` を使うと、説明をフェッチすることができます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### 10 個のファイルシステムのリストの取得
次の例では、GET リクエストを `file-systems` エンドポイント (`elasticfilesystem.us-west-2.amazonaws.com/2015-02-01/file-systems`)に送信します。このリクエストでは、`MaxItems` クエリ パラメータを指定して、ファイルシステムの説明の数を 10 に制限します。
#### リクエスト例
```
GET /2015-02-01/file-systems?MaxItems=10 HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140622T191208Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 499
{
"FileSystems":[
{
"OwnerId":"251839141158",
"CreationToken":"MyFileSystem1",
"FileSystemId":"fs-01234567",
"PerformanceMode" : "generalPurpose",
"CreationTime":"1403301078",
"LifeCycleState":"created",
"Name":"my first file system",
"NumberOfMountTargets":1,
"SizeInBytes":{
"Timestamp": 1403301078,
"Value": 29313618372,
"ValueInArchive": 201156,
"ValueInIA": 675432,
"ValueInStandard": 29312741784
}
}
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeFileSystems)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeFileSystems)
# DescribeLifecycleConfiguration
指定された EFS ファイルシステムの現在の `LifecycleConfiguration` オブジェクトを返します。ライフサイクル管理では、`LifecycleConfiguration` オブジェクトを使用して、ストレージクラス間でファイルを移動するタイミングを特定します。`LifecycleConfiguration` オブジェクトがないファイルシステムの場合、コールの応答には空の配列が返されます。
このオペレーションには、`elasticfilesystem:DescribeLifecycleConfiguration` オペレーションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/file-systems/FileSystemId/lifecycle-configuration HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DescribeLifecycleConfiguration_RequestSyntax) **
取得する `LifecycleConfiguration` オブジェクトのファイルシステムの ID（文字列）。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"LifecyclePolicies": [
{
"TransitionToArchive": "string",
"TransitionToIA": "string",
"TransitionToPrimaryStorageClass": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LifecyclePolicies](#API_DescribeLifecycleConfiguration_ResponseSyntax) **
ライフサイクル管理ポリシーの配列。EFS では、ファイルシステムごとに最大1つのポリシーがサポートされています。
型: [LifecyclePolicy](API_LifecyclePolicy.md) オブジェクトの配列
配列メンバー: 最大数は 3 項目です。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### ファイルシステムのライフサイクル設定を取得する
次のリクエストは、指定されたファイルシステムの `LifecycleConfiguration` オブジェクトを取得します。
#### リクエスト例
```
GET /2015-02-01/file-systems/fs-01234567/lifecycle-configuration HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20181120T221118Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 86
{
"LifecyclePolicies": [
{
"TransitionToArchive": "AFTER_270_DAYS"
},
{
"TransitionToIA": "AFTER_14_DAYS"
},
{
"TransitionToPrimaryStorageClass": "AFTER_1_ACCESS"
}
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeLifecycleConfiguration)
# DescribeMountTargets
ファイルシステムのすべての現在のマウントターゲット、または特定のマウントターゲットの説明を返します。現在のマウント・ターゲットをすべてリクエストする場合、応答で返されるマウント・ターゲットの順序は指定されていません。
このオペレーションには、`FileSystemId` で指定したファイルシステム ID 、または `MountTargetId` で指定したマウントターゲットのファイルシステムのいずれかで、`elasticfilesystem:DescribeMountTargets` のアクションに対する許可が必要です。
対応する CLI コマンドは `describe-mount-targets` です。
## リクエストの構文
```
GET /2015-02-01/mount-targets?AccessPointId=AccessPointId&FileSystemId=FileSystemId&Marker=Marker&MaxItems=MaxItems&MountTargetId=MountTargetId HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [AccessPointId](#API_DescribeMountTargets_RequestSyntax) **
(オプション) リスト表示するマウントターゲットがあるアクセスポイントの ID。`FileSystemId` または `MountTargetId`がリクエストに含まれていない場合は、必ずリクエストに含める必要があります。アクセスポイント ID または ARN を入力として受け入れます。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`
** [FileSystemId](#API_DescribeMountTargets_RequestSyntax) **
（オプション）マウントターゲットをリストするファイルシステムの ID（文字列）。`AccessPointId` または `MountTargetId`がリクエストに含まれていない場合は、必ずリクエストに含める必要があります。ファイルシステム ID または ARN を入力として受け入れます。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [Marker](#API_DescribeMountTargets_RequestSyntax) **
(オプション) 前の `DescribeMountTargets` オペレーション (文字列)から返された不透明なページ割りトークン。存在する場合は、前回のコールが中断された場所からリストを続行するように指定します。
長さの制限：最小長 1、最大長は 128 です。
パターン: `.+`
** [MaxItems](#API_DescribeMountTargets_RequestSyntax) **
(オプション) 応答で返すマウントターゲットの最大数。現在、この数値は自動的に 10 に設定され、その他の値は無視されます。100 を超えるマウントターゲットがある場合、レスポンスはページあたり 100 でページ割りされます。
有効な範囲: 最小値 は 1 です。
** [MountTargetId](#API_DescribeMountTargets_RequestSyntax) **
(オプション) 説明するマウントターゲットの ID (文字列)。`FileSystemId` が含まれていない場合は、リクエストに含める必要があります。マウントターゲット ID または ARN を入力として受け入れます。
長さの制限: 最小長は 13 です。最大長は 45 です。
Pattern: `^fsmt-[0-9a-f]{8,40}$`
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"Marker": "string",
"MountTargets": [
{
"AvailabilityZoneId": "string",
"AvailabilityZoneName": "string",
"FileSystemId": "string",
"IpAddress": "string",
"Ipv6Address": "string",
"LifeCycleState": "string",
"MountTargetId": "string",
"NetworkInterfaceId": "string",
"OwnerId": "string",
"SubnetId": "string",
"VpcId": "string"
}
],
"NextMarker": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Marker](#API_DescribeMountTargets_ResponseSyntax) **
リクエストに `Marker` が含まれていた場合、応答はこのフィールドにその値を返します。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [MountTargets](#API_DescribeMountTargets_ResponseSyntax) **
ファイルシステムのマウントターゲットを `MountTargetDescription` オブジェクトの配列として返します。
型: [MountTargetDescription](API_MountTargetDescription.md) オブジェクトの配列
** [NextMarker](#API_DescribeMountTargets_ResponseSyntax) **
値が存在する場合、返されるマウントターゲットがさらに多くなります。後続のリクエストでは、この値を使ってリクエストに `Marker` を指定することで、次のマウントターゲットの設定を取得することができます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** MountTargetNotFound **
指定された ID のマウントターゲットが発信者の AWS アカウントで見つからない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
## 例
### ファイル・システム用に作成されたマウント・ターゲットの説明を取得する
次のリクエストは、指定されたファイルシステムに対して作成されたマウントターゲットの説明を取得します。
#### リクエスト例
```
GET /2015-02-01/mount-targets?FileSystemId=fs-01234567 HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140622T191252Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 357
{
"MountTargets":[
{
"OwnerId":"251839141158",
"MountTargetId":"fsmt-01234567",
"FileSystemId":"fs-01234567",
"SubnetId":"subnet-01234567",
"LifeCycleState":"added",
"IpAddress":"10.0.2.42",
"NetworkInterfaceId":"eni-1bcb7772"
}
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeMountTargets)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeMountTargets)
# DescribeMountTargetSecurityGroups
マウントターゲットに対して現在有効なセキュリティグループを返します。このオペレーションには、マウントターゲットのネットワークインターフェースが作成されており、マウントターゲットのライフサイクル状態が `deleted` でないことが必要です。
このオペレーションには、次のアクションに対する許可が必要です。
+ マウントターゲットのファイルシステム上での `elasticfilesystem:DescribeMountTargetSecurityGroups` アクション。
+ マウントターゲットのネットワークインターフェース上での `ec2:DescribeNetworkInterfaceAttribute` アクション。
## リクエストの構文
```
GET /2015-02-01/mount-targets/MountTargetId/security-groups HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [MountTargetId](#API_DescribeMountTargetSecurityGroups_RequestSyntax) **
取得するセキュリティグループがあるマウントターゲットの ID。
長さの制限: 最小長は 13 です。最大長は 45 です。
パターン: `^fsmt-[0-9a-f]{8,40}$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"SecurityGroups": [ "string" ]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [SecurityGroups](#API_DescribeMountTargetSecurityGroups_ResponseSyntax) **
セキュリティグループの配列。
型: 文字列の配列
配列メンバー: 最大数は 100 項目です。
長さの制限: 最小長は 11 です。最大長は 43 です。
パターン: `^sg-[0-9a-f]{8,40}`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** IncorrectMountTargetState **
マウントターゲットがオペレーションで正しい状態でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** MountTargetNotFound **
指定された ID のマウントターゲットが発信者の AWS アカウントで見つからない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
## 例
### ファイルシステムに有効なセキュリティグループを取得
次の例では、マウントターゲットに関連付けられたネットワーク インターフェイスに有効なセキュリティグループを取得します。
#### リクエスト例
```
GET /2015-02-01/mount-targets/fsmt-9a13661e/security-groups HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T223513Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Length: 57
{
"SecurityGroups" : [
"sg-188d9f74"
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeMountTargetSecurityGroups)
# DescribeReplicationConfigurations
特定のファイルシステムに関するレプリケーション設定を取得します。ファイルシステムが指定されていない場合、 AWS アカウント のすべてのレプリケーション設定 AWS リージョン が取得されます。
## リクエストの構文
```
GET /2015-02-01/file-systems/replication-configurations?FileSystemId=FileSystemId&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DescribeReplicationConfigurations_RequestSyntax) **
特定のファイルシステムのレプリケーション設定は、ファイルシステム ID を指定することで取得できます。クロスアカウント、クロスリージョンレプリケーションの場合、アカウントは自身のリージョン内のファイルシステムのレプリケーション設定のみを記述できます。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [MaxResults](#API_DescribeReplicationConfigurations_RequestSyntax) **
(オプション) レスポンスで返されるオブジェクトの数を制限するには、`MaxItems` パラメータを指定します。デフォルト値は 100 です。
有効な範囲: 最小値 は 1 です。
** [NextToken](#API_DescribeReplicationConfigurations_RequestSyntax) **
`NextToken` は応答がページ割りされている場合に存在します。後続のリクエストで `NextToken` を使うと、次のページの出力をフェッチすることができます。
長さの制限：最小長 1、最大長は 128 です。
Pattern: `.+`
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Replications": [
{
"CreationTime": number,
"Destinations": [
{
"FileSystemId": "string",
"LastReplicatedTimestamp": number,
"OwnerId": "string",
"Region": "string",
"RoleArn": "string",
"Status": "string",
"StatusMessage": "string"
}
],
"OriginalSourceFileSystemArn": "string",
"SourceFileSystemArn": "string",
"SourceFileSystemId": "string",
"SourceFileSystemOwnerId": "string",
"SourceFileSystemRegion": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_DescribeReplicationConfigurations_ResponseSyntax) **
後続のリクエストで前のレスポンスから `NextToken` を使うと、追加の説明をフェッチすることができます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [Replications](#API_DescribeReplicationConfigurations_ResponseSyntax) **
返されるレプリケーション設定のコレクション。
型: [ReplicationConfigurationDescription](API_ReplicationConfigurationDescription.md) オブジェクトの配列
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ReplicationNotFound **
指定したファイルシステムにレプリケーション設定がない場合に返されます。
** ErrorCode **
ReplicationNotFound
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** ValidationException **
リクエストが行われた AWS リージョン で AWS Backup サービスが利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeReplicationConfigurations)
# DescribeTags
**注記**
非推奨 - `DescribeTags` アクションは非推奨であり、維持されません。EFS リソースに関連付けられているタグを表示するには、`ListTagsForResource` API アクションを使用します。
ファイルシステムに関連付けられたタグを返します。1回の `DescribeTags` コールの応答で返されるタグの順序と、複数回のコールの反復（ページ割りを使用する場合）の応答全体で返されるタグの順序は、指定されていません。
このオペレーションには、`elasticfilesystem:DescribeTags` アクションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/tags/FileSystemId/?Marker=Marker&MaxItems=MaxItems HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_DescribeTags_RequestSyntax) **
取得するタグセットが付けられたファイルシステムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** [Marker](#API_DescribeTags_RequestSyntax) **
(オプション) 前の `DescribeTags` オペレーション (文字列)から返された不透明ページ割りトークン。存在する場合は、前のコールが中断された場所からリストを続行するように指定します。
長さの制限：最小長 1、最大長は 128 です。
パターン: `.+`
** [MaxItems](#API_DescribeTags_RequestSyntax) **
(オプション) レスポンスで返すファイル システムタグの最大数。現在、この数値は自動的に 100 に設定され、その他の値は無視されます。100 を超えるタグがある場合、レスポンスはページあたり 100 でページ割りされます。
有効範囲: 最小値 1。
## リクエスト本文
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"Marker": "string",
"NextMarker": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [Marker](#API_DescribeTags_ResponseSyntax) **
リクエストに`Marker`が含まれている場合、応答はこのフィールドにその値を返します。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [NextMarker](#API_DescribeTags_ResponseSyntax) **
値が存在する場合、返されるタグがさらに多くなります。次のリクエストでは、`Marker` パラメータの値として `NextMarker` の値を指定することで、次のタグ設定を取得することができます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [Tags](#API_DescribeTags_ResponseSyntax) **
ファイルシステムに関連付けられたタグを `Tag` オブジェクトの配列として返します。
型: [Tag](API_Tag.md) オブジェクトの配列
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### ファイルシステムに関連付けられているタグの取得
次のリクエストは、指定されたファイルシステムに関連付けられたタグ（キーバリューのペア）を取得します。
#### リクエスト例
```
GET /2015-02-01/tags/fs-01234567/ HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T215404Z
Authorization: <...>
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-Type: application/json
Content-Length: 288
{
"Tags":[
{
"Key":"Name",
"Value":"my first file system"
},
{
"Key":"Fleet",
"Value":"Development"
},
{
"Key":"Developer",
"Value":"Alice"
}
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/DescribeTags)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DescribeTags)
# ListTagsForResource
最上位の EFS リソースのすべてのタグをリスト表示します。タグを取得するリソースの ID を入力する必要があります。
このオペレーションには、`elasticfilesystem:DescribeAccessPoints` アクションに対する許可が必要です。
## リクエストの構文
```
GET /2015-02-01/resource-tags/ResourceId?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [MaxResults](#API_ListTagsForResource_RequestSyntax) **
（オプション）レスポンスで返すタグオブジェクトの最大数を指定します。デフォルト値は 100 です。
有効範囲: 最小値 1。
** [NextToken](#API_ListTagsForResource_RequestSyntax) **
(オプション）応答のペイロードがページ割りされている場合、次のリクエストで `NextToken` を使用して、アクセスポイントの説明の次のページをフェッチできます。
長さの制限：最小長 1、最大長は 128 です。
パターン: `.+`
** [ResourceId](#API_ListTagsForResource_RequestSyntax) **
タグを取得する EFS リソースを指定します。この API エンドポイントを使用して、EFS ファイルシステムおよびアクセスポイントのタグを取得できます。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"NextToken": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [NextToken](#API_ListTagsForResource_ResponseSyntax) **
`NextToken` はレスポンスペイロードがページ割りされている場合に存在します。後続のリクエストで `NextToken` を使うと、次のページのアクセスポイントの説明をフェッチすることができます。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `.+`
** [Tags](#API_ListTagsForResource_ResponseSyntax) **
指定された EFS リソースのタグの配列。
型: [Tag](API_Tag.md) オブジェクトの配列
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/ListTagsForResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ListTagsForResource)
# ModifyMountTargetSecurityGroups
マウントターゲットに対して有効なセキュリティグループの設定を変更します。
マウントターゲットを作成すると、Amazon EFS によって新しいネットワーク インターフェイスも作成されます。詳細については、「[CreateMountTarget](API_CreateMountTarget.md)」を参照してください。このオペレーションでは、マウントターゲットに関連するネットワークインターフェースに有効なセキュリティグループを、リクエストで指定された `SecurityGroups` に置き換えます。このオペレーションには、マウントターゲットのネットワークインターフェースが作成されており、マウントターゲットのライフサイクル状態が `deleted` でないことが必要です。
このオペレーションには、次のアクションに対する許可が必要です。
+ マウントターゲットのファイルシステム上での `elasticfilesystem:ModifyMountTargetSecurityGroups` アクション。
+ マウントターゲットのネットワークインターフェース上での `ec2:ModifyNetworkInterfaceAttribute` アクション。
## リクエストの構文
```
PUT /2015-02-01/mount-targets/MountTargetId/security-groups HTTP/1.1
Content-type: application/json
{
"SecurityGroups": [ "string" ]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [MountTargetId](#API_ModifyMountTargetSecurityGroups_RequestSyntax) **
変更するセキュリティグループがあるマウントターゲットの ID。
長さの制限: 最小長は 13 です。最大長は 45 です。
パターン: `^fsmt-[0-9a-f]{8,40}$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [SecurityGroups](#API_ModifyMountTargetSecurityGroups_RequestSyntax) **
VPC セキュリティグループ ID の配列。
型: 文字列の配列
配列メンバー: 最大数は 100 項目です。
長さの制限: 最小長は 11 です。最大長は 43 です。
パターン: `^sg-[0-9a-f]{8,40}`
必須: いいえ
## レスポンスの構文
```
HTTP/1.1 204
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 204 レスポンスを返します。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** IncorrectMountTargetState **
マウントターゲットがオペレーションで正しい状態でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** MountTargetNotFound **
指定された ID のマウントターゲットが発信者の AWS アカウントで見つからない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** SecurityGroupLimitExceeded **
リクエストで指定された `SecurityGroups` の数が、アカウントクォータに基づく制限より大きい場合に返されます。いくつかのセキュリティグループを削除するか、アカウントクォータの引き上げをリクエストしてください。詳細については、「*Amazon VPC ユーザーガイド*」の「[Amazon VPC クォータ](https://docs.aws.amazon.com/vpc/latest/userguide/amazon-vpc-limits.html)」内の**セキュリティグループ**の表を参照してください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** SecurityGroupNotFound **
指定したセキュリティグループの 1 つがサブネットの仮想プライベートクラウド (VPC) に存在しない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 例
### マウントターゲットのセキュリティグループを置き換える
次の例では、マウントターゲットに関連付けられたネットワーク インターフェイスに有効なセキュリティグループを置き換えます。
#### リクエスト例
```
PUT /2015-02-01/mount-targets/fsmt-9a13661e/security-groups HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T223446Z
Authorization: <...>
Content-Type: application/json
Content-Length: 57
{
"SecurityGroups" : [
"sg-188d9f74"
]
}
```
#### レスポンス例
```
HTTP/1.1 204 No Content
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ModifyMountTargetSecurityGroups)
# PutAccountPreferences
このオペレーションを使用して、新しい EFS ファイルシステムとマウントターゲットリソースに、長い 17 文字 (63 ビット) または短い 8 文字 (32 ビット) のリソース ID を使用するように現在の AWS リージョン のアカウント環境設定を設定します。既存のリソース ID はすべて、変更の影響を受けません。EFS が長いリソース ID に移行するときに、オプトイン期間中に ID プリファレンスを設定できます。詳細については、「[Amazon EFS リソース ID の管理](https://docs.aws.amazon.com/efs/latest/ug/manage-efs-resource-ids.html)」を参照してください。
**注記**
2021 年 10 月以降、短い 8 文字形式のリソース ID を使用するようにアカウント設定をしようとすると、エラーが表示されます。エラーが発生し、ファイルシステムとマウントターゲットリソースに短い IDs を使用する必要がある場合は、 AWS サポートにお問い合わせください。
## リクエストの構文
```
PUT /2015-02-01/account-preferences HTTP/1.1
Content-type: application/json
{
"ResourceIdType": "string"
}
```
## URI リクエストパラメータ
リクエストでは URI パラメータを使用しません。
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [ResourceIdType](#API_PutAccountPreferences_RequestSyntax) **
ユーザーの に設定する EFS リソース ID 設定を AWS アカウント、現在の `LONG_ID` (17 文字) AWS リージョンまたは `SHORT_ID` (8 文字) で指定します。
2021 年 10 月以降、アカウント設定を `SHORT_ID` にするとエラーが表示されます。エラーが発生し、ファイルシステムとマウントターゲットリソースに短い IDs を使用する必要がある場合は、 AWS サポートにお問い合わせください。
型: 文字列
有効な値：`LONG_ID | SHORT_ID`
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"ResourceIdPreference": {
"ResourceIdType": "string",
"Resources": [ "string" ]
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [ResourceIdPreference](#API_PutAccountPreferences_ResponseSyntax) **
現在の AWS アカウントのリソースタイプとそのユーザーの ID 設定について説明します AWS リージョン。
型: [ResourceIdPreference](API_ResourceIdPreference.md) オブジェクト
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/PutAccountPreferences)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PutAccountPreferences)
# PutBackupPolicy
ファイルシステムのバックアップポリシーを更新します。このアクションは、ファイルシステムの自動バックアップをスタートまたは停止するために使用します。
## リクエストの構文
```
PUT /2015-02-01/file-systems/FileSystemId/backup-policy HTTP/1.1
Content-type: application/json
{
"BackupPolicy": {
"Status": "string"
}
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_PutBackupPolicy_RequestSyntax) **
バックアップポリシーを更新する EFS ファイルシステムを指定します。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [BackupPolicy](#API_PutBackupPolicy_RequestSyntax) **
`PutBackupPolicy` リクエストに含まれるバックアップポリシー。
型: [BackupPolicy](API_BackupPolicy.md) オブジェクト
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"BackupPolicy": {
"Status": "string"
}
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [BackupPolicy](#API_PutBackupPolicy_ResponseSyntax) **
ファイルシステムのバックアップポリシーについて説明し、自動バックアップをオンにするかオフにするかを示します。
型: [BackupPolicy](API_BackupPolicy.md) オブジェクト
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ValidationException **
リクエストが行われた AWS リージョン で AWS Backup サービスが利用できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/PutBackupPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PutBackupPolicy)
# PutFileSystemPolicy
Amazon EFS ファイルシステムに Amazon EFS `FileSystemPolicy` を適用します。ファイル システムポリシーは IAM リソースベースのポリシーで、複数のポリシーステートメントを含めることができます。ファイルシステムは、常に1つのファイルシステムポリシーを持っています。これは、デフォルトポリシー、またはこの API オペレーションを使用して設定または更新された明示的なポリシーにすることができます。EFS ファイル システムポリシーには 20,000 文字の制限があります。明示的なポリシーが設定されると、デフォルトポリシーが上書きされます。デフォルトのファイルシステムポリシーの詳細については、「[デフォルトの EFS ファイル システムポリシー](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html#default-filesystempolicy)」を参照してください。
**注記**
EFS ファイル システムポリシーには 20,000 文字の制限があります。
このオペレーションには、`elasticfilesystem:PutFileSystemPolicy` アクションに対する許可が必要です。
## リクエストの構文
```
PUT /2015-02-01/file-systems/FileSystemId/policy HTTP/1.1
Content-type: application/json
{
"BypassPolicyLockoutSafetyCheck": boolean,
"Policy": "string"
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_PutFileSystemPolicy_RequestSyntax) **
`FileSystemPolicy` の作成または更新を行う EFS ファイルシステムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [BypassPolicyLockoutSafetyCheck](#API_PutFileSystemPolicy_RequestSyntax) **
(オプション) `FileSystemPolicy` ロックアウトのセーフティチェックをバイパスするかどうかを指定するブール値。ロックアウトセーフティーチェックでは、リクエストに含まれるポリシーによって、ファイルシステムでの将来の `PutFileSystemPolicy` リクエストを行うことからリクエストを行う IAM プリンシパル をロックアウトするか、回避するかを決定します。`BypassPolicyLockoutSafetyCheck` から `True` に設定するのは、リクエストを行っている IAM プリンシパルがこのファイルシステムで後続の `PutFileSystemPolicy` リクエストを行わないようにする場合のみです。デフォルト値は `False` です。
タイプ: ブール値
必須: いいえ
** [Policy](#API_PutFileSystemPolicy_RequestSyntax) **
作成している `FileSystemPolicy`。JSON 形式のポリシー定義を受け入れます。EFS ファイル システム ポリシーには 20,000 文字の制限があります。ファイルシステムポリシーを構成する要素の詳細については、「[Amazon EFS 内のリソースベースのポリシー](https://docs.aws.amazon.com/efs/latest/ug/security_iam_service-with-iam.html#security_iam_service-with-iam-resource-based-policies)」を参照してください。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 20000 です。
パターン: `[\s\S]+`
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"FileSystemId": "string",
"Policy": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [FileSystemId](#API_PutFileSystemPolicy_ResponseSyntax) **
`FileSystemPolicy` が適用される EFS ファイルシステムを指定します。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [Policy](#API_PutFileSystemPolicy_ResponseSyntax) **
EFS ファイルシステムの JSON 形式の `FileSystemPolicy` です。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 20000 です。
パターン: `[\s\S]+`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** InvalidPolicyException **
`FileSystemPolicy` が不正な形式であったり、有効ではないパラメータ値や必須パラメータの欠落などのエラーを含む場合に返されます。ポリシー ロックアウトセーフティー チェックエラーの場合に返却されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
## 例
### EFS ファイルシステムポリシーの作成
次のリクエストは、すべての AWS プリンシパル`FileSystemPolicy`が指定された EFS ファイルシステムを読み取りおよび書き込みアクセス許可でマウントできるようにする を作成します。
#### リクエスト例
```
PUT /2015-02-01/file-systems/fs-01234567/file-system-policy HTTP/1.1
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"elasticfilesystem:ClientMount",
"elasticfilesystem:ClientWrite"
],
"Principal": {
"AWS": ["*"]
},
}
]
}
```
#### レスポンス例
```
{
"Version": "2012-10-17",
"Id": "1",
"Statement": [
{
"Sid": "efs-statement-abcdef01-1111-bbbb-2222-111122224444",
"Effect": "Allow",
"Action": [
"elasticfilesystem:ClientMount",
"elasticfilesystem:ClientWrite"
],
"Principal": {
"AWS": ["*"]
},
"Resource":"arn:aws:elasticfilesystem:us-east-1:1111222233334444:file-system/fs-01234567"
}
]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PutFileSystemPolicy)
# PutLifecycleConfiguration
このアクションを使用して、ファイルシステムのストレージを管理します。`LifecycleConfiguration` は、以下を定義する 1 つ以上の `LifecyclePolicy` オブジェクトで構成されます。
+ **`TransitionToIA`** — ファイルシステム内のファイルをプライマリストレージ (標準ストレージクラス) から低頻度アクセス (IA) ストレージに移動するタイミング。
+ ** `TransitionToArchive` **—ファイルシステム内のファイルを現在のストレージクラス (IA または標準ストレージ) からアーカイブストレージに移動するタイミング。
ファイルシステムは、IA ストレージに移行する前にアーカイブストレージに移行することはできません。したがって、TransitionToArchive を設定しないか、TransitionToIA よりも後に設定する必要があります。
**注記**
アーカイブストレージクラスは、エラスティックスループットモードと汎用パフォーマンスモードを使用するファイルシステムでのみ利用できます。
+ **`TransitionToPrimaryStorageClass`** — IA ストレージまたはアーカイブストレージでアクセスされたファイルシステム内のファイルを、プライマリストレージ (標準ストレージクラス) に戻すかどうか。
詳細については、「[ファイルシステムのストレージの管理](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html)」を参照してください。
各 Amazon EFS ファイルシステムは、ファイルシステム内のすべてのファイルに適用される 1 つのライフサイクル設定をサポートしています。指定されたファイルシステムに `LifecycleConfiguration` のオブジェクトがすでに存在する場合、`PutLifecycleConfiguration` のコールは既存の設定を変更します。リクエスト本文に空の `LifecyclePolicies` 配列を含む `PutLifecycleConfiguration` 呼び出しは、既存の `LifecycleConfiguration` をすべて削除します。リクエストでは次のようにを指定します。
+ ライフサイクル管理を有効化、無効化、または変更するファイルシステムのID。
+ ファイルをいつ IA ストレージやアーカイブストレージに移動し、いつプライマリストレージに戻すかを定義する、`LifecyclePolicy` オブジェクトの `LifecyclePolicies` 配列。
**注記**
Amazon EFS では、各 `LifecyclePolicy` オブジェクトが1つのトランジションしかないため、`LifecyclePolicies` 配列は別々の `LifecyclePolicy` オブジェクトで構成する必要があります。詳細については、次のセクションのリクエスト例を参照してください。
このオペレーションには、`elasticfilesystem:PutLifecycleConfiguration` オペレーションに対する許可が必要です。
暗号化されたファイルシステムに`LifecycleConfiguration`オブジェクトを適用するには、暗号化されたファイルシステムを作成したときと同じ AWS Key Management Service アクセス許可が必要です。
## リクエストの構文
```
PUT /2015-02-01/file-systems/FileSystemId/lifecycle-configuration HTTP/1.1
Content-type: application/json
{
"LifecyclePolicies": [
{
"TransitionToArchive": "string",
"TransitionToIA": "string",
"TransitionToPrimaryStorageClass": "string"
}
]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_PutLifecycleConfiguration_RequestSyntax) **
`LifecycleConfiguration` オブジェクトを作成するファイルシステムの ID（文字列）。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [LifecyclePolicies](#API_PutLifecycleConfiguration_RequestSyntax) **
ファイルシステムの `LifecycleConfiguration` オブジェクトを定義する `LifecyclePolicy` オブジェクトの配列。`LifecycleConfiguration` オブジェクトは、ライフサイクル管理に次の通知を行います。
+ **`TransitionToIA`** — ファイルシステム内のファイルをプライマリストレージ (標準ストレージクラス) から低頻度アクセス (IA) ストレージに移動するタイミング。
+ ** `TransitionToArchive` **—ファイルシステム内のファイルを現在のストレージクラス (IA または標準ストレージ) からアーカイブストレージに移動するタイミング。
ファイルシステムは、IA ストレージに移行する前にアーカイブストレージに移行することはできません。したがって、TransitionToArchive を設定しないか、TransitionToIA よりも後に設定する必要があります。
**注記**
アーカイブストレージクラスは、エラスティックスループットモードと汎用パフォーマンスモードを使用するファイルシステムでのみ利用できます。
+ **`TransitionToPrimaryStorageClass`**— IA ストレージまたはアーカイブストレージでアクセスされたファイルシステム内のファイルを、プライマリストレージ (標準ストレージクラス) に戻すかどうか。
`put-lifecycle-configuration` CLIコマンドまたは `PutLifecycleConfiguration` APIアクションを使用する場合、Amazon EFS では、各 `LifecyclePolicy` オブジェクトに移行が 1 つだけあることが求められます。つまり、リクエスト本文では、`LifecyclePolicies` が `LifecyclePolicy` オブジェクトの配列として構成される必要があります (ストレージの移行ごとに 1 オブジェクト)。詳細については、次のセクションのリクエスト例を参照してください。
型: [LifecyclePolicy](API_LifecyclePolicy.md) オブジェクトの配列
配列メンバー: 最大数は 3 項目です。
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"LifecyclePolicies": [
{
"TransitionToArchive": "string",
"TransitionToIA": "string",
"TransitionToPrimaryStorageClass": "string"
}
]
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [LifecyclePolicies](#API_PutLifecycleConfiguration_ResponseSyntax) **
ライフサイクル管理ポリシーの配列。EFS では、ファイルシステムごとに最大1つのポリシーがサポートされています。
型: [LifecyclePolicy](API_LifecyclePolicy.md) オブジェクトの配列
配列メンバー: 最大数は 3 項目です。
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### ライフサイクル設定の作成
次の例では、`PutLifecycleConfiguration` アクションを使用して `LifecyclePolicy` オブジェクトを作成します。この例では、EFS に次のことを指示するライフサイクルポリシーを作成します。
+ 過去 30 日間に標準ストレージでアクセスされていないファイルシステム内のファイルをすべて IA ストレージに移動する。
+ 過去 90 日間に標準ストレージでアクセスされていないファイルシステム内のファイルをすべてアーカイブストレージに移動する。
+ IA ストレージまたはアーカイブストレージでアクセスされたファイルを標準ストレージに戻す。アーカイブストレージクラスは、エラスティックスループットモードと汎用パフォーマンスモードを使用するファイルシステムでのみ利用できます。
詳細については、「[EFS ストレージクラス](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)」と「[ファイルシステムのストレージの管理](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html)」を参照してください。
#### リクエスト例
```
PUT /2015-02-01/file-systems/fs-0123456789abcdefb/lifecycle-configuration HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20181122T232908Z
Authorization: <...>
Content-type: application/json
Content-Length: 86
{
"LifecyclePolicies": [
{
"TransitionToArchive": "AFTER_90_DAYS"
},
{
"TransitionToIA": "AFTER_30_DAYS"
},
{
"TransitionToPrimaryStorage": "AFTER_1_ACCESS"
}
]
}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-type: application/json
Content-Length: 86
{
"LifecyclePolicies": [
{
"TransitionToArchive": "AFTER_90_DAYS"
},
{
"TransitionToIA": "AFTER_30_DAYS"
},
{
"TransitionToPrimaryStorage": "AFTER_1_ACCESS"
}
]
}
```
### ライフサイクル設定 CLI リクエストの例
この例では、PutLifecycleConfiguration の使い方の一例を示します。
#### リクエスト例
```
aws efs put-lifecycle-configuration \
--file-system-id fs-0123456789abcdefb \
--lifecycle-policies "[{"TransitionToArchive":"AFTER_90_DAYS"},
{"TransitionToIA":"AFTER_30_DAYS"},
{"TransitionToPrimaryStorageClass":"AFTER_1_ACCESS"}]
--region us-west-2 \
--profile adminuser
```
#### レスポンス例
```
{
"LifecyclePolicies": [
{
"TransitionToArchive": "AFTER_90_DAYS"
},
{
"TransitionToIA": "AFTER_30_DAYS"
},
{
"TransitionToPrimaryStorageClass": "AFTER_1_ACCESS"
}
]
}
```
### ライフサイクル管理の無効化
次の例では、指定したファイルシステムのライフサイクル管理を無効にします。
#### リクエスト例
```
PUT /2015-02-01/file-systems/fs-01234567/lifecycle-configuration HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20181122T232908Z
Authorization: <...>
Content-type: application/json
Content-Length: 86
{
"LifecyclePolicies": [ ]
}
```
#### レスポンス例
```
HTTP/1.1 200 OK
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
Content-type: application/json
Content-Length: 86
{
"LifecyclePolicies": [ ]
}
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PutLifecycleConfiguration)
# TagResource
EFS リソースのタグの作成。この API オペレーションを使用して、EFS ファイルシステムおよびアクセスポイントのタグを作成できます。
このオペレーションには、`elasticfilesystem:TagResource` アクションに対する許可が必要です。
## リクエストの構文
```
POST /2015-02-01/resource-tags/ResourceId HTTP/1.1
Content-type: application/json
{
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [ResourceId](#API_TagResource_RequestSyntax) **
タグを作成する EFS リソースを指定する ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [Tags](#API_TagResource_RequestSyntax) **
追加する `Tag` オブジェクトの配列。各 `Tag` オブジェクトタグはキーバリューのペアです。
型: [Tag](API_Tag.md) オブジェクトの配列
必須: はい
## レスポンスの構文
```
HTTP/1.1 200
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## 例
### ファイルシステム上でのタグの作成
次のリクエストは、指定されたファイルシステムに 3 つのタグ（`"key1"`,`"key2"`,および `"key3"`）を作成します。
#### リクエスト例
```
POST /2015-02-01/tag-resource/fs-01234567 HTTP/1.1
Host: elasticfilesystem.us-west-2.amazonaws.com
x-amz-date: 20140620T221118Z
Authorization: <...>
Content-Type: application/json
Content-Length: 160
{
"Tags": [
{
"Key": "key1",
"Value": "value1"
},
{
"Key": "key2",
"Value": "value2"
},
{
"Key": "key3",
"Value": "value3"
}
]
}
```
#### レスポンス例
```
HTTP/1.1 204 no content
x-amzn-RequestId: 01234567-89ab-cdef-0123-456789abcdef
```
## 以下の資料も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/TagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/TagResource)
# UntagResource
EFS リソースからタグを削除します この API オペレーションを使用して、EFS ファイルシステムおよびアクセスポイントからタグを削除できます。
このオペレーションには、`elasticfilesystem:UntagResource` アクションに対する許可が必要です。
## リクエストの構文
```
DELETE /2015-02-01/resource-tags/ResourceId?tagKeys=TagKeys HTTP/1.1
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [ResourceId](#API_UntagResource_RequestSyntax) **
タグを削除する EFS リソースを指定します。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:(access-point/fsap|file-system/fs)-[0-9a-f]{8,40}|fs(ap)?-[0-9a-f]{8,40})$`
必須: はい
** [TagKeys](#API_UntagResource_RequestSyntax) **
指定された EFS リソースから削除するキーバリュー タグペアのキー。
配列メンバー: 最小数は 1 項目です。最大数は 50 項目です。
長さの制限：最小長 1、最大長は 128 です。
パターン: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`
必須: はい
## リクエストボディ
リクエストにリクエスト本文がありません。
## レスポンスの構文
```
HTTP/1.1 200
```
## レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
## エラー
** AccessPointNotFound **
指定された`AccessPointId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
## その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/UntagResource)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/UntagResource)
# UpdateFileSystem
スループットモード、または既存のファイルシステムのプロビジョニングされたスループットの量を更新します。
## リクエストの構文
```
PUT /2015-02-01/file-systems/FileSystemId HTTP/1.1
Content-type: application/json
{
"ProvisionedThroughputInMibps": number,
"ThroughputMode": "string"
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_UpdateFileSystem_RequestSyntax) **
更新するファイル システムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [ProvisionedThroughputInMibps](#API_UpdateFileSystem_RequestSyntax) **
(オプション) 作成するファイルシステムにプロビジョニングするスループットを、毎秒メビバイト (MiBps) で計測します。`ThroughputMode` が `provisioned` に設定されている場合は必須です。有効な値は 1～3414 MiBps で、上限はリージョンによって異なります。この制限を引き上げるには、 にお問い合わせください サポート。詳細については、*Amazon EFS ユーザーガイド*の「[引き上げ可能な Amazon EFS クォータ](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits)」を参照してください。
型: 倍精度浮動小数点数
値の範囲: 最小値 は 1.0 です。
必須: いいえ
** [ThroughputMode](#API_UpdateFileSystem_RequestSyntax) **
（オプション）ファイル システムのスループットモードを更新します。スループットモードを更新しない場合は、リクエストでこの値を指定する必要はありません。`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](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムが配置されているアベイラビリティーゾーンの一意で一貫性のある識別子。これは、1 ゾーンファイルシステムでのみ有効です。たとえば、 `use1-az1`は us-east-1 のアベイラビリティーゾーン ID であり AWS リージョン、すべての に同じ場所があります AWS アカウント。
タイプ: 文字列
** [AvailabilityZoneName](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムが配置されている AWS アベイラビリティーゾーンについて説明し、1 ゾーンファイルシステムでのみ有効です。詳細については、「**Amazon EFS ユーザーガイド」の「[EFS ストレージクラスの使用](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)」を参照してください。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [CreationTime](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムが作成された時間 (秒単位) (1970-01-01T00:00:00Z から)。
型: タイムスタンプ
** [CreationToken](#API_UpdateFileSystem_ResponseSyntax) **
リクエストで指定された不透明な文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
** [Encrypted](#API_UpdateFileSystem_ResponseSyntax) **
true の場合はファイルシステムの暗号化を示すブール値。
型: ブール値
** [FileSystemArn](#API_UpdateFileSystem_ResponseSyntax) **
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](#API_UpdateFileSystem_ResponseSyntax) **
Amazon EFS によって割り当てられるファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
** [FileSystemProtection](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムの保護について説明します。
型: [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md) オブジェクト
** [KmsKeyId](#API_UpdateFileSystem_ResponseSyntax) **
暗号化されたファイルシステムの保護 AWS KMS key に使用される の ID。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^([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](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムのライフサイクルフェーズ。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
** [Name](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムには、`Name` タグをはじめとするタグを追加することができます。詳細については、「[CreateFileSystem](API_CreateFileSystem.md)」を参照してください。ファイルシステムに `Name` タグがある場合、Amazon EFS はこのフィールドの値を返します。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
** [NumberOfMountTargets](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムが持つ現在のマウントターゲットの数。詳細については、「[CreateMountTarget](API_CreateMountTarget.md)」を参照してください。
型: 整数
有効範囲: 最小値 は 0 です。
** [OwnerId](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムを AWS アカウント 作成した 。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
** [PerformanceMode](#API_UpdateFileSystem_ResponseSyntax) **
ファイル システムのパフォーマンス モード。
型: 文字列
有効な値：`generalPurpose | maxIO`
** [ProvisionedThroughputInMibps](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムのプロビジョニングされたスループットの量を MiBps で表したもの。`ThroughputMode` を `provisioned` に設定したファイルシステムに有効です。
型: 倍精度浮動小数点数
有効な範囲: 最小値 は 1.0 です。
** [SizeInBytes](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムに保存されているデータの最新の測定サイズ（バイト）を `Value` のフィールドに、そのサイズが決定された時間を `Timestamp` のフィールドに入力しています。`Timestamp` 値は、1970-01-01T00:00:00Z 以降の整数秒数です。`SizeInBytes`値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない場合に結果整合性があります。つまり、`SizeInBytes`は、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。
型: [FileSystemSize](API_FileSystemSize.md) オブジェクト
** [Tags](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムに関連するタグで、`Tag` のオブジェクトの配列として表示されます。
型: [Tag](API_Tag.md) オブジェクトの配列
** [ThroughputMode](#API_UpdateFileSystem_ResponseSyntax) **
ファイルシステムのスループットモードを表示。詳細については、「**Amazon EFS ユーザーガイド」の「[スループットモード](https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes)」を参照してください。
型: 文字列
有効な値：`bursting | provisioned | elastic`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InsufficientThroughputCapacity **
追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後でもう一度お試しください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 503
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ThroughputLimitExceeded **
スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** TooManyRequests **
スループットモードを変更するか、プロビジョニングされたスループット値を減らす前に少なくとも 24 時間以上待たない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 429
## 以下も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/UpdateFileSystem)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/UpdateFileSystem)
# UpdateFileSystemProtection
ファイルシステムの保護を更新します。
このオペレーションには、`elasticfilesystem:UpdateFileSystemProtection` アクションに対する許可が必要です。
## リクエストの構文
```
PUT /2015-02-01/file-systems/FileSystemId/protection HTTP/1.1
Content-type: application/json
{
"ReplicationOverwriteProtection": "string"
}
```
## URI リクエストパラメータ
リクエストでは、次の URI パラメータを使用します。
** [FileSystemId](#API_UpdateFileSystemProtection_RequestSyntax) **
更新するファイルシステムの ID。
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
## リクエストボディ
リクエストは以下の JSON 形式のデータを受け入れます。
** [ReplicationOverwriteProtection](#API_UpdateFileSystemProtection_RequestSyntax) **
ファイルシステムのレプリケーション上書き保護の状態。
+ `ENABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは書き込み可能です。レプリケーション上書き保護はデフォルトで `ENABLED` です。
+ `DISABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更できます。
+ `REPLICATING`— ファイルシステムがレプリケーション設定のデスティネーションファイルシステムとして使用されています。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更されます。
レプリケーション設定を削除すると、ファイルシステムのレプリケーション上書き保護が再び有効になり、ファイルシステムが書き込み可能になります。
型: 文字列
有効な値：`ENABLED | DISABLED | REPLICATING`
必須：いいえ
## レスポンスの構文
```
HTTP/1.1 200
Content-type: application/json
{
"ReplicationOverwriteProtection": "string"
}
```
## レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
** [ReplicationOverwriteProtection](#API_UpdateFileSystemProtection_ResponseSyntax) **
ファイルシステムのレプリケーション上書き保護の状態。
+ `ENABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは書き込み可能です。レプリケーション上書き保護はデフォルトで `ENABLED` です。
+ `DISABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更できます。
+ `REPLICATING`— ファイルシステムがレプリケーション設定のデスティネーションファイルシステムとして使用されています。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更されます。
レプリケーション設定を削除すると、ファイルシステムのレプリケーション上書き保護が再び有効になり、ファイルシステムが書き込み可能になります。
型: 文字列
有効な値：`ENABLED | DISABLED | REPLICATING`
## エラー
** BadRequest **
リクエストの形式が正しくない場合や、無効なパラメータ値や必須パラメータの欠落などのエラーが含まれている場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** FileSystemNotFound **
指定された`FileSystemId`値がリクエスタの に存在しない場合に返されます AWS アカウント。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 404
** IncorrectFileSystemLifeCycleState **
ファイルシステムのライフサイクル状態が「使用可能」でない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** InsufficientThroughputCapacity **
追加のスループットをプロビジョニングするのに十分な容量がない場合に返されます。この値は、プロビジョニングされたスループットモードでファイルシステムを作成しようとしたとき、既存のファイルシステムのプロビジョニングされたスループットを上げようとしたとき、または既存のファイルシステムをバーストからプロビジョニングされたスループットモードに変更しようとしたときに返されることがあります。後でもう一度お試しください。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 503
** InternalServerError **
サーバー側でエラーが発生した場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 500
** ReplicationAlreadyExists **
ファイルシステムが既にレプリケーション設定に含まれている場合に返されます。>
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 409
** ThroughputLimitExceeded **
スループット制限の 1024 MiB/s に達したため、スループットモードまたはプロビジョニングされたスループットの量を変更できない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 400
** TooManyRequests **
スループットモードを変更するか、プロビジョニングされたスループット値を減らす前に少なくとも 24 時間以上待たない場合に返されます。
** ErrorCode **
エラーコードは、エラー状態を個別に識別する文字列です。エラーを検出してタイプ別に処理するプログラムによって読み取りおよび解釈されるためのものです。
** Message **
エラーメッセージには、エラー状態の一般的な説明が英語で含まれます。これは人が理解できるようにするためのものです。シンプルなプログラムの場合、処理できない、または処理されないエラー状態が発生すると、メッセージがエンドユーザーに直接表示されます。より徹底したエラー処理を備え、適切に国際化されている洗練されたプログラムでは、エラーメッセージが無視される傾向にあります。
HTTP ステータスコード: 429
## 以下も参照してください。
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS コマンドラインインターフェイス V2](https://docs.aws.amazon.com/goto/cli2/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for .NET V4](https://docs.aws.amazon.com/goto/DotNetSDKV4/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for Go v2](https://docs.aws.amazon.com/goto/SdkForGoV2/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for JavaScript V3](https://docs.aws.amazon.com/goto/SdkForJavaScriptV3/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for Kotlin](https://docs.aws.amazon.com/goto/SdkForKotlin/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for Python](https://docs.aws.amazon.com/goto/boto3/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/UpdateFileSystemProtection)
# データ型
以下のデータ型 (タイプ) がサポートされています。
+ [AccessPointDescription](API_AccessPointDescription.md)
+ [BackupPolicy](API_BackupPolicy.md)
+ [CreationInfo](API_CreationInfo.md)
+ [Destination](API_Destination.md)
+ [DestinationToCreate](API_DestinationToCreate.md)
+ [FileSystemDescription](API_FileSystemDescription.md)
+ [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md)
+ [FileSystemSize](API_FileSystemSize.md)
+ [LifecyclePolicy](API_LifecyclePolicy.md)
+ [MountTargetDescription](API_MountTargetDescription.md)
+ [PosixUser](API_PosixUser.md)
+ [ReplicationConfigurationDescription](API_ReplicationConfigurationDescription.md)
+ [ResourceIdPreference](API_ResourceIdPreference.md)
+ [RootDirectory](API_RootDirectory.md)
+ [Tag](API_Tag.md)
# AccessPointDescription
EFS ファイル システムアクセスポイントについて説明します。
## コンテンツ
** AccessPointArn **
アクセスポイントに関連付けられている一意の Amazon リソースネーム (ARN)。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}$`
必須: いいえ
** AccessPointId **
Amazon EFS によって割り当てられたアクセスポイントの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:access-point/fsap-[0-9a-f]{8,40}|fsap-[0-9a-f]{8,40})$`
必須: いいえ
** ClientToken **
冪等性の作成を保証するためにリクエストで指定された不透明な文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
必須: いいえ
** FileSystemId **
アクセスポイントが適用される EFS ファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: いいえ
** LifeCycleState **
アクセスポイントのライフサイクルフェーズを識別します。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
必須：いいえ
** Name **
このアクセスポイントの名前。これは、`Name` タグの値です。
タイプ: 文字列
必須: いいえ
** OwnerId **
アクセスポイントリソースを所有する AWS アカウント を識別します。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
必須: いいえ
** PosixUser **
アクセスポイント上の、ユーザー ID、グループ ID、およびセカンダリグループ ID を含む完全な POSIX アイデンティティ。アクセスポイントを使用する NFS クライアントによるすべてのファイルオペレーションに使用されます。
型: [PosixUser](API_PosixUser.md) オブジェクト
必須: いいえ
** RootDirectory **
アクセスポイントを使用して、アクセスポイントが NFS クライアントにルートディレクトリとして公開する EFS ファイルシステム上のディレクトリ。
型: [RootDirectory](API_RootDirectory.md) オブジェクト
必須: いいえ
** Tags **
アクセスポイントに関連付けられたタグ。タグオブジェクトの配列として表示されます。
型: [Tag](API_Tag.md) オブジェクトの配列
必須：いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/AccessPointDescription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/AccessPointDescription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/AccessPointDescription)
# BackupPolicy
毎日の自動バックアップを作成するために使用されるファイルシステムのバックアップポリシー。ステータスの値が `ENABLED` の場合、ファイルシステムは自動的にバックアップされます。詳細については、「[自動バックアップ](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#automatic-backups)」を参照してください。
## 内容
** Status **
ファイルシステムの バックアップ ポリシーの状態を説明します。
+ **`ENABLED`** - EFS はファイルシステムを自動的にバックアップします。
+ **`ENABLING`** - EFS はファイルシステムの自動バックアップをオンにします。
+ **`DISABLED`** - ファイルシステムの自動バックアップがオフになっています。
+ **`DISABLING`** - EFS はファイルシステムの自動バックアップをオフにします。
型: 文字列
有効な値：`ENABLED | ENABLING | DISABLED | DISABLING`
必須: はい
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/BackupPolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/BackupPolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/BackupPolicy)
# CreationInfo
指定した `RootDirectory` > `Path` が存在しない場合は必須です。アクセスポイントの `RootDirectory` > `Path` に適用する POSIX ID とアクセス許可を指定します。アクセスポイントのルートディレクトリが存在しない場合、クライアントがアクセスポイントに接続すると EFS はこれらの設定を使用して作成します。`CreationInfo` を指定する場合は、すべてのプロパティの値を含める必要があります。
Amazon EFS では、CreationInfo (OwnUid、OwnGID、ディレクトリのアクセス許可) を指定した場合にのみ、ルートディレクトリが作成されます。この情報を指定しない場合、Amazon EFS はルートディレクトリを作成しません。ルートディレクトリが存在しない場合に、アクセスポイントを使用してマウントしようとすると、失敗します。
**重要**
`CreationInfo` を指定せず、指定した `RootDirectory` が存在しない場合、アクセスポイントを使用してファイルシステムをマウントしようとすると失敗します。
## 内容
** OwnerGid **
`RootDirectory` に適用する POSIX グループ ID を指定します。0 から 2^32 (4294967295) までの値を受け入れます。
型: Long
有効な範囲: 最小値 は 0 です。最大値は 4,294,967,295 です。
必須: はい
** OwnerUid **
`RootDirectory` に適用する POSIX ユーザー ID を指定します。0 から 2^32 (4294967295) までの値を受け入れます。
型: Long
有効な範囲: 最小値 は 0 です。最大値は 4,294,967,295 です。
必須: はい
** Permissions **
`RootDirectory` に適用する POSIX アクセス許可を、ファイルのモードビットを表す 8 進数の形式で指定します。
タイプ: 文字列
長さの制約: 最小長は 3 です。最大長は 4 です。
パターン: `^[0-7]{3,4}$`
必須: はい
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/CreationInfo)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/CreationInfo)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/CreationInfo)
# Destination
レプリケーション設定内のデスティネーションファイルシステムを記述します。
## 内容
** FileSystemId **
デスティネーション Amazon EFS ファイルシステムの ID。
型: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** Region **
デスティネーションファイルシステムのある AWS リージョン。
型: 文字列
長さの制限: 最小長は 1 です。最大長 64
パターン: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`
必須: はい
** Status **
レプリケーション設定のステータスについて説明します。レプリケーションステータスの詳細については、「[Amazon EFS ユーザーガイド](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html)」の「*レプリケーションの詳細の表示*」を参照してください。
型: 文字列
有効な値：`ENABLED | ENABLING | DELETING | ERROR | PAUSED | PAUSING`
必須: はい
** LastReplicatedTimestamp **
デスティネーションファイルシステムで最新の同期が正常に完了した時刻。この時間より前にソースファイルシステム上のデータに加えられた変更は、デスティネーションファイルシステムに正常にレプリケートされました。この時間以降に発生した変更は、完全にはレプリケートされない可能性があります。
型: タイムスタンプ
必須: いいえ
** OwnerId **
デスティネーションファイルシステムが存在する AWS アカウント の ID。
型: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
必須: いいえ
** RoleArn **
Amazon EFS が代わりにレプリケーションを実行できるようにするソースアカウントの IAM ロールの Amazon リソースネーム (ARN)。これは、同じアカウントレプリケーションの場合はオプションで、クロスアカウントレプリケーションの場合は必須です。
型: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
必須: いいえ
** StatusMessage **
レプリケーションの送信先設定の `PAUSED` または `ERRROR` 状態に関する詳細を提供するメッセージ。レプリケーションステータスメッセージの詳細については、「[Amazon EFS ユーザーガイド](https://docs.aws.amazon.com/efs/latest/ug/awsbackup.html#restoring-backup-efsmonitoring-replication-status.html)」の「*レプリケーションの詳細の表示*」を参照してください。
型: 文字列
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/Destination)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/Destination)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/Destination)
# DestinationToCreate
レプリケーション設定の新規または既存のデスティネーションファイルシステムについて説明します。
+ 新しいファイルシステムにレプリケートする場合は、送信先ファイルシステムのファイルシステム ID を指定しないでください。Amazon EFS は、新しい空のファイルシステムを作成します。1 ゾーンストレージの場合は、ファイルシステムを作成するアベイラビリティーゾーンを指定します。デフォルトの KMS キー以外の AWS Key Management Service キーを使用するには、使用するキーを指定します。詳細については、「[Amazon EFS ユーザーガイド](https://docs.aws.amazon.com/efs/latest/ug/create-replication.html)」の「*新しい Amazon EFS ファイルシステムへのレプリケーションの設定*」を参照してください。
**注記**
ファイルシステムが作成された後は、KMS キーを変更したり、パフォーマンスモードを変更したりすることはできません。
+ ソースファイルシステムと同じアカウントにある既存のファイルシステムにレプリケートする場合は、送信先ファイルシステムの ID または Amazon リソースネーム (ARN) を指定する必要があります。送信先ファイルシステムのレプリケーション上書き保護を無効にする必要があります。詳細については、「*Amazon EFS ユーザーガイド*」の「[既存のファイルシステムへのレプリケーション](https://docs.aws.amazon.com/efs/latest/ug/efs-replication#replicate-existing-destination)」を参照してください。
+ ファイルシステムをソースファイルシステムとは異なるアカウントにあるファイルシステムにレプリケートする場合 (クロスアカウントレプリケーション）、ファイルシステムの ARN と、Amazon EFS が送信先アカウントでレプリケーションを実行できるようにする IAM ロールを指定する必要があります。送信先ファイルシステムのレプリケーション上書き保護を無効にする必要があります。詳細については、「*Amazon EFS ユーザーガイド*」の「[AWS アカウント 間のレプリケーション](https://docs.aws.amazon.com/efs/latest/ug/cross-account-replication.html)」を参照してください。
## 内容
** AvailabilityZoneName **
1 ゾーンストレージを使用するファイルシステムを作成するには、デスティネーションファイルシステムを作成するアベイラビリティーゾーンの名前を指定します。
型: 文字列
長さの制限: 最小長は 1 です。最大長 64
パターン: `.+`
必須: いいえ
** FileSystemId **
送信先に使用するファイルシステムの ID または ARN。クロスアカウントレプリケーションの場合、これは ARN である必要があります。ファイルシステムのレプリケーション上書きレプリケーションを無効にする必要があります。ID または ARN が指定されていない場合は、新しいファイルシステムが作成されます。
既存のファイルシステムへのレプリケーションを最初に設定すると、Amazon EFS はソースファイルシステムのデータと一致するように、送信先ファイルシステムにデータを書き込むか、送信先ファイルシステムから既存のデータを削除します。送信先ファイルシステムのデータを変更しない場合は、代わりに新しいファイルシステムにレプリケートする必要があります。詳細については、「[https://docs.aws.amazon.com/efs/latest/ug/create-replication.html](https://docs.aws.amazon.com/efs/latest/ug/create-replication.html)」を参照してください。
型: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: いいえ
** KmsKeyId **
デスティネーションファイルシステムの暗号化に使用する AWS Key Management Service (AWS KMS) キーを指定します。KMS キーを指定しない場合、Amazon EFS は、Amazon EFS 用のデフォルト KMS キー、`/aws/elasticfilesystem` を使用します。この ID は以下のいずれかの形式になります。
+ キー ID - キーの一意の識別子 (例: `1234abcd-12ab-34cd-56ef-1234567890ab`)。
+ ARN - キーの ARN。例: `arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab`。
+ キーのエイリアス - 以前に作成したキーの表示名 (例: `alias/projectKey1`)。
+ キー エイリアス ARN - キー エイリアスの ARN (例: `arn:aws:kms:us-west-2:444455556666:alias/projectKey1`)。
型: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^([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/_-]+))))$`
必須: いいえ
** Region **
リージョンストレージを使用するファイルシステムを作成するには、デスティネーションファイルシステムを作成する AWS リージョン を指定します。リージョンは、ソースファイルシステムを所有する AWS アカウント に対して有効にする必要があります。詳細については、「**AWS 全般のリファレンスガイド」の「[AWS リージョンの管理](https://docs.aws.amazon.com/general/latest/gr/rande-manage.html#rande-manage-enable)」を参照してください。
型: 文字列
長さの制限: 最小長は 1 です。最大長 64
パターン: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`
必須: いいえ
** RoleArn **
Amazon EFS が代わりにレプリケーションを実行できるようにするソースアカウントの IAM ロールの Amazon リソースネーム (ARN)。これは、同じアカウントレプリケーションの場合はオプションで、クロスアカウントレプリケーションの場合は必須です。
型: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `arn:(aws[a-zA-Z-]*)?:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/DestinationToCreate)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/DestinationToCreate)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/DestinationToCreate)
# FileSystemDescription
ファイルシステムの説明。
## 内容
** CreationTime **
ファイルシステムが作成された時間 (秒単位) (1970-01-01T00:00:00Z 以降)。
型: タイムスタンプ
必須: はい
** CreationToken **
リクエストで指定された不透明な文字列。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長 64
パターン: `.+`
必須: はい
** FileSystemId **
Amazon EFS によって割り当てられたファイルシステムの ID。
タイプ: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** LifeCycleState **
ファイルシステムのライフサイクルフェーズ。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
必須: はい
** NumberOfMountTargets **
ファイル・システムが持つ現在のマウント・ターゲットの数。詳細については、「[CreateMountTarget](API_CreateMountTarget.md)」を参照してください。
型: 整数
値の範囲: 最小値 は 0 です。
必須: はい
** OwnerId **
ファイルシステムを作成した AWS アカウント。
タイプ: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
必須: はい
** PerformanceMode **
ファイル システムのパフォーマンス モード。
型: 文字列
有効な値：`generalPurpose | maxIO`
必須: はい
** SizeInBytes **
ファイルシステムに保存されているデータの最新の既知の計測サイズ（バイト単位）を `Value` のフィールドに、そのサイズが決定された時刻を `Timestamp` のフィールドに入力しています。`Timestamp` 値は、1970-01-01T00:00:00Z 以降の整数秒数です。`SizeInBytes`値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない場合に結果整合性があります。つまり、`SizeInBytes`は、ファイルシステムが 2 時間以上変更されていない場合のみ、実際のサイズを表します。それ以外の場合、値はファイルシステムの特定の時点での正確なサイズではありません。
型: [FileSystemSize](API_FileSystemSize.md) オブジェクト
必須: はい
** Tags **
ファイルシステムに関連するタグで、`Tag` オブジェクトの配列として表示されます。
型: [Tag](API_Tag.md) オブジェクトの配列
必須: はい
** AvailabilityZoneId **
ファイルシステムが配置されているアベイラビリティーゾーンの一意で一貫性のある識別子。これは、1 ゾーンファイルシステムでのみ有効です。例えば、`use1-az1` は us-east-1 AWS リージョンのアベイラビリティーゾーン ID であり、すべての AWS アカウントで同じ場所を示します。
タイプ: 文字列
必須: いいえ
** AvailabilityZoneName **
ファイルシステムが配置されている AWS アベイラビリティーゾーンについて説明します。これは、1 ゾーンファイルシステムでのみ有効です。詳細については、「**Amazon EFS ユーザーガイド」の「[EFS ストレージクラスの使用](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html)」を参照してください。
タイプ: 文字列
長さの制約: 最小長は 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`
タイプ: 文字列
必須: いいえ
** FileSystemProtection **
ファイルシステムの保護について説明します。
型: [FileSystemProtectionDescription](API_FileSystemProtectionDescription.md) オブジェクト
必須: いいえ
** KmsKeyId **
暗号化されたファイルシステムの保護に使用する AWS KMS key の ID。
タイプ: 文字列
長さの制約: 最大長は 2,048 です。
パターン: `^([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/_-]+))))$`
必須: いいえ
** Name **
ファイルシステムには、`Name` タグをはじめとするタグを追加することができます。詳細については、「[CreateFileSystem](API_CreateFileSystem.md)」を参照してください。ファイルシステムに `Name` タグがある場合、Amazon EFS はこのフィールドの値を返します。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
必須: いいえ
** ProvisionedThroughputInMibps **
ファイルシステムのプロビジョニングされたスループットの量を MiBps で表したもの。`ThroughputMode` を `provisioned` に設定したファイルシステムに有効です。
型: 倍精度浮動小数点数
値の範囲: 最小値 は 1.0 です。
必須: いいえ
** ThroughputMode **
ファイルシステムのスループットモードを表示します。詳細については、「**Amazon EFS ユーザーガイド」の「[スループットモード](https://docs.aws.amazon.com/efs/latest/ug/performance.html#throughput-modes)」を参照してください。
型: 文字列
有効な値：`bursting | provisioned | elastic`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemDescription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemDescription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemDescription)
# FileSystemProtectionDescription
ファイルシステムの保護について説明します。
## 内容
** ReplicationOverwriteProtection **
ファイルシステムのレプリケーション上書き保護の状態。
+ `ENABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは書き込み可能です。レプリケーション上書き保護はデフォルトで `ENABLED` です。
+ `DISABLED` - ファイルシステムをレプリケーション設定のデスティネーションファイルシステムとして使用することはできません。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更できます。
+ `REPLICATING`— ファイルシステムがレプリケーション設定のデスティネーションファイルシステムとして使用されています。ファイルシステムは読み取り専用で、EFS レプリケーションでのみ変更されます。
レプリケーション設定を削除すると、ファイルシステムのレプリケーション上書き保護が再び有効になり、ファイルシステムが書き込み可能になります。
型: 文字列
有効な値：`ENABLED | DISABLED | REPLICATING`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemProtectionDescription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemProtectionDescription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemProtectionDescription)
# FileSystemSize
ファイル・システムに格納されているデータの最新の既知のメーター・サイズ（バイト単位）。`Value`フィールド、およびそのサイズがその中で決定された時刻`Timestamp`フィールド。この値は、ファイルシステムの一貫したスナップショットのサイズを表すものではありませんが、ファイルシステムへの書き込みがない際に結果整合性があります。つまり、この値は実際のサイズを表し、ファイルシステムが数時間以上変更されない場合のみです。それ以外の場合、値は必ずしもファイルシステムの特定の時点での正確なサイズではありません。
## 内容
** Value **
ファイルシステムに保存されているデータの最新の既知の従量制サイズ (バイト単位)。
型: Long
有効な範囲: 最小値 は 0 です。
必須: はい
** Timestamp **
`Value` フィールドで返されたデータのサイズが決定された時間です。値は、1970-01-01T00:00:00Z 以降の整数秒数です。
型: タイムスタンプ
必須: いいえ
** ValueInArchive **
アーカイブストレージクラスに保存されているデータの最新の既知の計測サイズ (バイト単位)。
タイプ：長整数
有効な範囲: 最小値 は 0 です。
必須: いいえ
** ValueInIA **
低頻度アクセス ストレージクラスに保存されているデータの最新の既知の従量制サイズ (バイト単位)。
型: Long
有効な範囲: 最小値 は 0 です。
必須: いいえ
** ValueInStandard **
スタンダード ストレージクラスに保存されているデータの最新の既知の計測されたサイズ (バイト単位)。
型: Long
有効な範囲: 最小値 は 0 です。
必須：いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/FileSystemSize)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/FileSystemSize)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/FileSystemSize)
# LifecyclePolicy
ライフサイクル管理で使用される、ストレージクラス間でファイルを移行するタイミングを指定するポリシーについて説明します。詳細については、「[ファイルシステムのストレージの管理](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html)」を参照してください。
**注記**
`put-lifecycle-configuration` CLIコマンドまたは `PutLifecycleConfiguration` APIアクションを使用する場合、Amazon EFS では、各 `LifecyclePolicy` オブジェクトに移行が 1 つだけあることが求められます。つまり、リクエスト本文では、`LifecyclePolicies` が `LifecyclePolicy` オブジェクトの配列として構成される必要があります (移行ごとに 1 オブジェクト)。詳細については、[PutLifecycleConfiguration](API_PutLifecycleConfiguration.md) の「リクエスト例」を参照してください。
## 内容
** TransitionToArchive **
プライマリストレージ (標準ストレージクラス) でファイルが最後にアクセスされてから、アーカイブストレージに移動するまでの日数。ディレクトリの内容を一覧表示するなどのメタデータオペレーションは、ファイルアクセスイベントとしてカウントされません。
型: 文字列
有効な値：`AFTER_1_DAY | AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_DAYS`
必須：いいえ
** TransitionToIA **
プライマリストレージ (標準ストレージクラス) でファイルが最後にアクセスされてから、低頻度アクセス (IA) ストレージに移動するまでの日数。ディレクトリの内容を一覧表示するなどのメタデータオペレーションは、ファイルアクセスイベントとしてカウントされません。
型: 文字列
有効な値：`AFTER_7_DAYS | AFTER_14_DAYS | AFTER_30_DAYS | AFTER_60_DAYS | AFTER_90_DAYS | AFTER_1_DAY | AFTER_180_DAYS | AFTER_270_DAYS | AFTER_365_DAYS`
必須：いいえ
** TransitionToPrimaryStorageClass **
IA ストレージまたはアーカイブストレージでアクセスしたファイルをプライマリ (標準) ストレージに戻すかどうか。ディレクトリの内容を一覧表示するなどのメタデータオペレーションは、ファイルアクセスイベントとしてカウントされません。
型: 文字列
有効な値：`AFTER_1_ACCESS`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/LifecyclePolicy)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/LifecyclePolicy)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/LifecyclePolicy)
# MountTargetDescription
マウントターゲットの説明です。
## 内容
** FileSystemId **
マウントターゲットが意図されているファイルシステムの ID。
型: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** LifeCycleState **
マウントターゲットのライフサイクル状態。
型: 文字列
有効な値：`creating | available | updating | deleting | deleted | error`
必須: はい
** MountTargetId **
システム割り当てマウントターゲット ID。
型: 文字列
長さの制限: 最小長は 13 です。最大長は 45 です。
パターン: `^fsmt-[0-9a-f]{8,40}$`
必須: はい
** SubnetId **
マウントターゲットのサブネットの ID。
型: 文字列
長さの制限: 最小長は 15 です。最大長は 47 です。
パターン: `^subnet-[0-9a-f]{8,40}$`
必須: はい
** AvailabilityZoneId **
マウントターゲットが存在するアベイラビリティーゾーンの一意で一貫性のある識別子。例えば、`use1-az1` は、us-east-1 リージョンの AZ ID で、すべての AWS アカウント アカウントで同じ場所になります。
型: 文字列
必須: いいえ
** AvailabilityZoneName **
マウントターゲットが配置されているアベイラビリティーゾーンの名前。アベイラビリティーゾーンは、それぞれ AWS アカウント の名前に個別にマッピングされます。例えば、AWS アカウント のアベイラビリティーゾーン `us-east-1a` の場所は、別の AWS アカウント の `us-east-1a` と同じ場所ではないかもしれません。
型: 文字列
長さの制限: 最小長は 1 です。最大長 64
パターン: `.+`
必須: いいえ
** IpAddress **
マウントターゲットの IPv4 アドレス。
型: 文字列
長さの制限: 最小長は 7 です。最大長は 15 です。
パターン: `^[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$`
必須: いいえ
** Ipv6Address **
マウントターゲットの IPv6 アドレス。
型: 文字列
長さの制約: 最小長は 3 です。最大長は 39 です。
必須: いいえ
** NetworkInterfaceId **
マウントターゲットを作成したときに Amazon EFS が作成したネットワークインターフェイスの ID。
型: 文字列
必須: いいえ
** OwnerId **
AWS アカウントリソースを所有する ID。
型: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
必須: いいえ
** VpcId **
マウントターゲットが設定されている 仮想プライベートクラウド (VPC) ID。
型: 文字列
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/MountTargetDescription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/MountTargetDescription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/MountTargetDescription)
# PosixUser
アクセスポイント上の、ユーザー ID、グループ ID、およびセカンダリグループ ID を含む完全な POSIX アイデンティティ。アクセスポイントを使用する NFS クライアントによって実行されるすべてのファイル システムオペレーションに使用されます。
## 内容
** Gid **
このアクセスポイントを使用するすべての ファイル システムオペレーションに使用される POSIX グループ ID。
タイプ：長整数
有効な範囲: 最小値 は 0 です。最大値は 4,294,967,295 です。
必須: はい
** Uid **
このアクセスポイントを使用するすべての ファイル システムオペレーションに使用される POSIX ユーザーID。
型: Long
有効な範囲: 最小値 は 0 です。最大値は 4,294,967,295 です。
必須: はい
** SecondaryGids **
このアクセスポイントを使用するすべての ファイル システムオペレーションに使用されるセカンダリ POSIX グループ ID。
型: longの配列
配列メンバー: 最小数は 0 項目です。最大数は 16 項目です。
有効範囲: 最小値 は 0 です。最大値は 4,294,967,295 です。
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/PosixUser)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/PosixUser)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/PosixUser)
# ReplicationConfigurationDescription
特定のファイルシステムのレプリケーション設定を記述します。
## 内容
** CreationTime **
レプリケーション設定の作成日を記述します。
型: タイムスタンプ
必須: はい
** Destinations **
デスティネーションオブジェクトの配列。サポートされているデスティネーションオブジェクトは 1 つだけです。
型: [Destination](API_Destination.md) オブジェクトの配列
必須: はい
** OriginalSourceFileSystemArn **
レプリケーション設定の元のソース EFS ファイルシステムの Amazon リソースネーム (ARN)。
型: 文字列
必須: はい
** SourceFileSystemArn **
レプリケーション設定内の現在のソースファイルシステムの Amazon リソースネーム (ARN)。
型: 文字列
必須: はい
** SourceFileSystemId **
レプリケートされたソースの Amazon EFS ファイルシステムの ID。
型: 文字列
長さの制約: 最大長は 128 です。
パターン: `^(arn:aws[-a-z]*:elasticfilesystem:[0-9a-z-:]+:file-system/fs-[0-9a-f]{8,40}|fs-[0-9a-f]{8,40})$`
必須: はい
** SourceFileSystemRegion **
ソースの EFS ファイルシステムがある AWS リージョン。
型: 文字列
長さの制限: 最小長は 1 です。最大長 64
パターン: `^[a-z]{2}-((iso[a-z]{0,1}-)|(gov-)){0,1}[a-z]+-{0,1}[0-9]{0,1}$`
必須: はい
** SourceFileSystemOwnerId **
ソースファイルシステムが存在する AWS アカウント の ID。
型: 文字列
長さの制限: 最大長は 14 です。
パターン: `^(\d{12})|(\d{4}-\d{4}-\d{4})$`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ReplicationConfigurationDescription)
# ResourceIdPreference
現在 AWS リージョン のユーザー AWS アカウント のリソースタイプとその ID 設定について説明します。
## 内容
** ResourceIdType **
EFS リソース ID 設定を、`LONG_ID`(17 文字) または`SHORT_ID`(8 文字)のいずれかで識別します。
型: 文字列
有効な値：`LONG_ID | SHORT_ID`
必須：いいえ
** Resources **
ID プリファレンス設定が適用される Amazon EFS リソースを`FILE_SYSTEM`および`MOUNT_TARGET`で識別します。
型: 文字列の配列
有効な値: `FILE_SYSTEM | MOUNT_TARGET`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/ResourceIdPreference)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/ResourceIdPreference)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/ResourceIdPreference)
# RootDirectory
アクセスポイントがアクセスを提供する Amazon EFS ファイルシステム上のディレクトリを指定します。アクセスポイントは、指定されたファイルシステムのパスを、アクセスポイントを使用するアプリケーションにファイルシステムのルートディレクトリとして公開します。アクセスポイントを使用する NFS クライアントは、アクセスポイントの `RootDirectory` とそのサブディレクトリ内のデータのみにアクセスできます。
## 内容
** CreationInfo **
(オプション) アクセスポイントの `RootDirectory` に適用する POSIX ID とアクセス許可を指定します。指定した `RootDirectory` > `Path` が存在しない場合、クライアントがアクセスポイントに接続すると EFS は`CreationInfo` 設定を使用してルートディレクトリを作成します。`CreationInfo` を指定する場合は、すべてのプロパティに値を指定する必要があります。
`CreationInfo` を指定せず、指定した `RootDirectory` > `Path` が存在しない場合、アクセスポイントを使用してファイルシステムをマウントしようとすると失敗します。
型: [CreationInfo](API_CreationInfo.md) オブジェクト
必須: いいえ
** Path **
アクセスポイントを使用して、EFS ファイルシステムにアクセスする NFS クライアントにルートディレクトリとして公開する EFS ファイルシステムのパスを指定します。パスには、最大 4 つのサブディレクトリを含めることができます。指定したパスが存在しない場合は、`CreationInfo` を指定する必要があります。
タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 100 です。
パターン: `^(\/|(\/(?!\.)+[^$#<>;`|&?{}^*/\n]+){1,4})$`
必須: いいえ
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/RootDirectory)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/RootDirectory)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/RootDirectory)
# Tag
タグはキーバリューのペアで構成されます。使用許可の文字は、UTF-8で表現できる文字、空白、数字、および次の文字です：` + - = . _ : /`。
## 内容
** Key **
タグキー (文字列)。キーのスタートを `aws:` にすることはできません。
タイプ: 文字列
長さの制限: 最小長は 1 です。最大長は 128 です。
パターン: `^(?![aA]{1}[wW]{1}[sS]{1}:)([\p{L}\p{Z}\p{N}_.:/=+\-@]+)$`
必須: はい
** Value **
タグキーの値。
タイプ: 文字列
長さの制約: 最大長は 256 です。
パターン: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`
必須: はい
## 以下の資料も参照してください。
言語固有の AWS SDK のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
+ [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/elasticfilesystem-2015-02-01/Tag)
+ [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/elasticfilesystem-2015-02-01/Tag)
+ [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/elasticfilesystem-2015-02-01/Tag)