paws.compute (version 0.1.0)

ec2_modify_snapshot_attribute: Adds or removes permission settings for the specified snapshot

Description

Adds or removes permission settings for the specified snapshot. You may add or remove specified AWS account IDs from a snapshot's list of create volume permissions, but you cannot do both in a single API call. If you need to both add and remove account IDs for a snapshot, you must use multiple API calls.

Usage

ec2_modify_snapshot_attribute(Attribute, CreateVolumePermission,
  GroupNames, OperationType, SnapshotId, UserIds, DryRun)

Arguments

Attribute

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

CreateVolumePermission

A JSON representation of the snapshot attribute modification.

GroupNames

The group to modify for the snapshot.

OperationType

The type of operation to perform to the attribute.

SnapshotId

[required] The ID of the snapshot.

UserIds

The account ID to modify for the snapshot.

DryRun

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.

Request syntax

svc$modify_snapshot_attribute(
  Attribute = "productCodes"|"createVolumePermission",
  CreateVolumePermission = list(
    Add = list(
      list(
        Group = "all",
        UserId = "string"
      )
    ),
    Remove = list(
      list(
        Group = "all",
        UserId = "string"
      )
    )
  ),
  GroupNames = list(
    "string"
  ),
  OperationType = "add"|"remove",
  SnapshotId = "string",
  UserIds = list(
    "string"
  ),
  DryRun = TRUE|FALSE
)

Details

Encrypted snapshots and snapshots with AWS Marketplace product codes cannot be made public. Snapshots encrypted with your default CMK cannot be shared with other accounts.

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

Examples

# NOT RUN {
# This example modifies snapshot ``snap-1234567890abcdef0`` to remove the
# create volume permission for a user with the account ID
# ``123456789012``. If the command succeeds, no output is returned.
# }
# NOT RUN {
svc$modify_snapshot_attribute(
  Attribute = "createVolumePermission",
  OperationType = "remove",
  SnapshotId = "snap-1234567890abcdef0",
  UserIds = list(
    "123456789012"
  )
)
# }
# NOT RUN {
# This example makes the snapshot ``snap-1234567890abcdef0`` public.
# }
# NOT RUN {
svc$modify_snapshot_attribute(
  Attribute = "createVolumePermission",
  GroupNames = list(
    "all"
  ),
  OperationType = "add",
  SnapshotId = "snap-1234567890abcdef0"
)
# }
# NOT RUN {
# }