翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
PutFileSystemPolicy
Amazon EFS ファイルシステムに Amazon EFS FileSystemPolicy を適用します。ファイル システムポリシーは IAM リソースベースのポリシーで、複数のポリシーステートメントを含めることができます。ファイルシステムは、常に1つのファイルシステムポリシーを持っています。これは、デフォルトポリシー、またはこの API オペレーションを使用して設定または更新された明示的なポリシーにすることができます。EFS ファイル システムポリシーには 20,000 文字の制限があります。明示的なポリシーが設定されると、デフォルトポリシーが上書きされます。デフォルトのファイルシステムポリシーの詳細については、「デフォルトの EFS ファイル システムポリシー」を参照してください。
注記
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
-
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
-
(オプション)
FileSystemPolicyロックアウトのセーフティチェックをバイパスするかどうかを指定するブール値。ロックアウトセーフティーチェックでは、リクエストに含まれるポリシーによって、ファイルシステムでの将来のPutFileSystemPolicyリクエストを行うことからリクエストを行う IAM プリンシパル をロックアウトするか、回避するかを決定します。BypassPolicyLockoutSafetyCheckからTrueに設定するのは、リクエストを行っている IAM プリンシパルがこのファイルシステムで後続のPutFileSystemPolicyリクエストを行わないようにする場合のみです。デフォルト値はFalseです。型: ブール値
必須: いいえ
- Policy
-
作成している
FileSystemPolicy。JSON 形式のポリシー定義を受け入れます。EFS ファイル システム ポリシーには 20,000 文字の制限があります。ファイルシステムポリシーを構成する要素の詳細については、「Amazon EFS 内のリソースベースのポリシー」を参照してください。タイプ: 文字列
長さの制約: 最小長は 1 です。最大長は 20000 です。
パターン:
[\s\S]+必須: はい
レスポンスの構文
HTTP/1.1 200
Content-type: application/json
{
"FileSystemId": "string",
"Policy": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
- FileSystemId
-
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
-
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 を使用する方法の詳細については、以下を参照してください。
