ec2_modify_image_attribute {aws.ecx}

Modify Image Attribute

Description

Modify Image Attribute

Usage

ec2_modify_image_attribute(
  ImageId,
  Attribute = NULL,
  Description = NULL,
  LaunchPermission = NULL,
  OperationType = NULL,
  ProductCode = NULL,
  UserGroup = NULL,
  UserId = NULL,
  Value = 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

ImageId

Character. The ID of the AMI.

Attribute

Character. The name of the attribute to modify.[optional]

Description

Object. A new description for the AMI.[optional]

LaunchPermission

Object. A new launch permission for the AMI.[optional]

OperationType

Character. The operation type.[optional]

ProductCode

List. The DevPay product codes. After you add a product code to an AMI, it can\'t be removed.[optional]

UserGroup

List. The user groups.[optional]

UserId

List. The AWS account IDs.[optional]

Value

Character. The value of the attribute being modified.[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

ImageId

The ID of the AMI.

Attribute

The name of the attribute to modify. The valid values are description, launchPermission, and productCodes.

Description

A new description for the AMI.

LaunchPermission

A new launch permission for the AMI.

OperationType

The operation type. This parameter can be used only when the Attribute parameter is launchPermission.

ProductCode

The DevPay product codes. After you add a product code to an AMI, it can\'t be removed.

UserGroup

The user groups. This parameter can be used only when the Attribute parameter is launchPermission.

UserId

The AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Value

The value of the attribute being modified. This parameter can be used only when the Attribute parameter is description or productCodes.

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.