Update an S3 policy configuration
Updates the S3 policy configuration for an SVM to change policy details, such as comments or policy statements. Use this endpoint to manage and adjust S3 policies according to your requirements.
HTTP method and endpoint
PATCH /protocols/s3/services/{svm.uuid}/policies/{name}
Introduced in
ONTAP 9.8
Usage notes
Updates the S3 policy configuration of an SVM.
Important notes
-
The following fields can be modified for a policy:
-
comment- Any information related to the policy. -
statements- Specifies the array of policy statements.
-
Related ONTAP commands
-
vserver object-store-server policy modify -
vserver object-store-server policy modify-statement
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
name |
string |
path |
True |
Policy name |
svm.uuid |
string |
path |
True |
UUID of the SVM to which this object belongs. |
Request Body
| Name | Type | Description |
|---|---|---|
comment |
string |
Can contain any additional information about the S3 policy. |
read-only |
boolean |
Specifies whether or not the s3 policy is read only. This parameter should not be specified in the POST method. |
statements |
array[s3_policy_statement] |
Specifies the policy statements. |
svm |
Example request
{
"comment": "S3 policy.",
"statements": [
{
"actions": [
"*"
],
"effect": "allow",
"index": 0,
"resources": [
"bucket1",
"bucket1/*"
],
"sid": "FullAccessToBucket1"
}
],
"svm": {
"name": "svm1",
"uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
}
}
Response
Status: 200, Ok
Error
Status: Default
ONTAP Error Response Codes
| Error Code | Description |
|---|---|
92405906 |
The specified action name is invalid. |
92405963 |
Failed to create policy statements for policy. Reason: "{reason of failure}". Resolve all issues and retry the operation. |
92405954 |
Object store server read-only policies do not support create, modify, delete, add-statement, delete-statement and modify-statement operations. |
Definitions
See Definitions
s3_policy_statement
Specifies information about a single access policy statement.
| Name | Type | Description |
|---|---|---|
actions |
array[string] |
For each resource, S3 supports a set of operations. The resource operations allowed or denied are identified by an action list:
|
effect |
string |
Specifies whether access is allowed or denied. If access (to allow) is not granted explicitly to a resource, access is implicitly denied. Access can also be denied explicitly to a resource, in order to make sure that a user cannot access it, even if a different policy grants access. |
index |
integer |
Specifies a unique statement index used to identify a particular statement. This parameter should not be specified in the POST method. A statement index is automatically generated and is retrieved using the GET method. |
resources |
array[string] |
|
sid |
string |
Specifies the statement identifier which contains additional information about the statement. |
href
| Name | Type | Description |
|---|---|---|
href |
string |
_links
svm
| Name | Type | Description |
|---|---|---|
name |
string |
The name of the SVM. |
uuid |
string |
The unique identifier of the SVM. |
s3_policy
An S3 policy is an object. It defines resource (bucket, folder or object) permissions. These policies get evaluated when an object store user user makes a request. Permissions in the policies determine whether the request is allowed or denied.
| Name | Type | Description |
|---|---|---|
comment |
string |
Can contain any additional information about the S3 policy. |
read-only |
boolean |
Specifies whether or not the s3 policy is read only. This parameter should not be specified in the POST method. |
statements |
array[s3_policy_statement] |
Specifies the policy statements. |
svm |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
error
| Name | Type | Description |
|---|---|---|
arguments |
array[error_arguments] |
Message arguments |
code |
string |
Error code |
message |
string |
Error message |
target |
string |
The target parameter that caused the error. |