Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . ec2 ]

modify-image-attribute

Description

Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time. You can use the Attribute parameter to specify the attribute or one of the following parameters: Description , LaunchPermission , or ProductCode .

AWS Marketplace product codes cannot be modified. Images with an AWS Marketplace product code cannot be made public.

To enable the SriovNetSupport enhanced networking attribute of an image, enable SriovNetSupport on an instance and create an AMI from the instance.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  modify-image-attribute
[--attribute <value>]
[--description <value>]
--image-id <value>
[--launch-permission <value>]
[--operation-type <value>]
[--product-codes <value>]
[--user-groups <value>]
[--user-ids <value>]
[--value <value>]
[--dry-run | --no-dry-run]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--attribute (string)

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

--description (structure)

A new description for the AMI.

--image-id (string)

The ID of the AMI.

--launch-permission (structure)

A new launch permission for the AMI.

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"
    }
    ...
  ]
}

--operation-type (string)

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

Possible values:

  • add
  • remove

--product-codes (list)

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

Syntax:

"string" "string" ...

--user-groups (list)

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

Syntax:

"string" "string" ...

--user-ids (list)

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

Syntax:

"string" "string" ...

--value (string)

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

--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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

Example 1: To make an AMI public

The following modify-instance-attribute example makes the specified AMI public.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Add=[{Group=all}]"

This command produces no output.

Example 2: To make an AMI private

The following modify-instance-attribute example makes the specified AMI private.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Remove=[{Group=all}]"

This command produces no output.

Example 3: To grant launch permission to an AWS account

The following modify-instance-attribute example grants launch permissions to the specified AWS account.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Add=[{UserId=123456789012}]"

This command produces no output.

Example 4: To remove launch permission from an AWS account

The following modify-instance-attribute example removes launch permissions from the specified AWS account.

aws ec2 modify-image-attribute \
    --image-id ami-5731123e \
    --launch-permission "Remove=[{UserId=123456789012}]"

Output

None