ec2_modify_snapshot_attribute {aws.ecx}

Modify Snapshot Attribute

Description

Modify Snapshot Attribute

Usage

ec2_modify_snapshot_attribute(
  SnapshotId,
  Attribute = NULL,
  CreateVolumePermission = NULL,
  UserGroup = NULL,
  OperationType = NULL,
  UserId = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

SnapshotId

Character. The ID of the snapshot.

Attribute

Character. The snapshot attribute to modify. Only volume creation permissions can be modified.[optional]

CreateVolumePermission

Object. A JSON representation of the snapshot attribute modification.[optional]

UserGroup

List. The group to modify for the snapshot.[optional]

OperationType

Character. The type of operation to perform to the attribute.[optional]

UserId

List. The account ID to modify for the snapshot.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

SnapshotId

The ID of the snapshot.

Attribute

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

CreateVolumePermission

A JSON representation of the snapshot attribute modification.

UserGroup

The group to modify for the snapshot.

OperationType

The type of operation to perform to the attribute.

UserId

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.