modify-snapshot-attribute¶

Description¶

Adds or removes permission settings for the specified snapshot. You may add or remove specified Amazon Web Services account IDs from a snapshot’s list of create volume permissions, but you cannot do both in a single operation. If you need to both add and remove account IDs for a snapshot, you must use multiple operations. You can make up to 500 modifications to a snapshot in a single operation.

Encrypted snapshots and snapshots with Amazon Web Services Marketplace product codes cannot be made public. Snapshots encrypted with your default KMS key cannot be shared with other accounts.

For more information about modifying snapshot permissions, see Share a snapshot in the Amazon Elastic Compute Cloud User Guide .

Synopsis¶

  modify-snapshot-attribute
[--attribute <value>]
[--create-volume-permission <value>]
[--group-names <value>]
[--operation-type <value>]
--snapshot-id <value>
[--user-ids <value>]
[--dry-run | --no-dry-run]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--attribute (string)

The snapshot attribute to modify. Only volume creation permissions can be modified.

Possible values:

productCodes

createVolumePermission

--create-volume-permission (structure)

A JSON representation of the snapshot attribute modification.

Add -> (list)

Adds the specified Amazon Web Services account ID or group to the list.

(structure)

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

Group -> (string)

The group to be added or removed. The possible value is all .

UserId -> (string)

The ID of the Amazon Web Services account to be added or removed.

Remove -> (list)

Removes the specified Amazon Web Services account ID or group from the list.

(structure)

Describes the user or group to be added or removed from the list of create volume permissions for a volume.

Group -> (string)

The group to be added or removed. The possible value is all .

UserId -> (string)

The ID of the Amazon Web Services account to be added or removed.

Shorthand Syntax:

Add=[{Group=string,UserId=string},{Group=string,UserId=string}],Remove=[{Group=string,UserId=string},{Group=string,UserId=string}]

JSON Syntax:

{
  "Add": [
    {
      "Group": "all",
      "UserId": "string"
    }
    ...
  ],
  "Remove": [
    {
      "Group": "all",
      "UserId": "string"
    }
    ...
  ]
}

--group-names (list)

The group to modify for the snapshot.

(string)

Syntax:

"string" "string" ...

--operation-type (string)

The type of operation to perform to the attribute.

Possible values:

add

remove

--snapshot-id (string)

The ID of the snapshot.

--user-ids (list)

The account ID to modify for the snapshot.

(string)

Syntax:

"string" "string" ...

--dry-run | --no-dry-run (boolean)

Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is DryRunOperation . Otherwise, it is UnauthorizedOperation .

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

Example 1: To modify a snapshot attribute

The following modify-snapshot-attribute example updates the createVolumePermission attribute for the specified snapshot, removing volume permissions for the specified user.

aws ec2 modify-snapshot-attribute \
    --snapshot-id snap-1234567890abcdef0 \
    --attribute createVolumePermission \
    --operation-type remove \
    --user-ids 123456789012

Example 2: To make a snapshot public

The following modify-snapshot-attribute example makes the specified snapshot public.

aws ec2 modify-snapshot-attribute \
    --snapshot-id snap-1234567890abcdef0 \
    --attribute createVolumePermission \
    --operation-type add \
    --group-names all

Output¶

None

Table of Contents

Feedback

User Guide