ec2-modify-image-attribute

Description

Modifies an attribute of an AMI.

The short version of this command is ec2mimatt.

Syntax

ec2-modify-image-attribute ami_id {-l (-a entity | -r entity) | --product-code code}

Options

Name	Description	Required
`ami_id`	The AMI ID. Type: String Default: None Example: ami-2bb65342	Yes
`-p, --product-code` `code`	Product code to add to the specified Amazon S3-backed AMI. Once you add a product code to an AMI, it can't be removed. Type: String Default: None Example: -p D662E989	No
`-l, --launch-permission`	Used with the --add or --remove flags to grant or revoke launch permissions. Type: String Default: None Example: --launch-permission	Yes
`-a, --add` `entity`	Adds a launch permission for the specified AWS account or for all accounts. Type: String Valid Values: `AWS account identifier` \| `all` Default: None Example: --launch-permission --add all	Yes
`-r, --remove` `entity`	Removes a launch permission for the specified AWS account or for all users. Type: String Valid Values: `AWS account identifier` \| `all` Default: None Example: --launch-permission --remove all	Yes

Common Options

Option	Description
`--region` `REGION`	Overrides the Region specified in the `EC2_URL` environment variable and the URL specified by the `-U` option. Default: The `EC2_URL` environment variable, or `us-east-1` if the environment variable is not set. Example: `--region eu-west-1`
`-U, --url` `URL`	`URL` is the uniform resource locator of the Amazon EC2 web service entry point. Default: The `EC2_URL` environment variable, or https://ec2.amazonaws.com if the environment variable is not set. Example: `-U https://ec2.amazonaws.com`
`-K, --private-key` `EC2-PRIVATE-KEY`	The private key to use when constructing requests to Amazon EC2. Default: The value of the `EC2_PRIVATE_KEY` environment variable. Example: `-K pk-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`-C, --cert` `EC2-CERT`	The X.509 certificate to use when constructing requests to Amazon EC2. Default: The value of the `EC2_CERT` environment variable. Example: `-C cert-HKZYKTAIG2ECMXYIBH3HXV4ZBZQ55CLO.pem`
`--connection-timeout` `TIMEOUT`	Specifies a connection timeout (in seconds). Example: --connection-timeout 30
`--request-timeout` `TIMEOUT`	Specifies a request timeout (in seconds). Example: --request-timeout 45
`-v, --verbose`	Displays verbose output by showing the SOAP request and response on the command line. This is particularly useful if you are building tools to talk directly to our SOAP API.
`-H, --headers`	Displays column headers in the output.
`--show-empty-fields`	Shows empty columns as `(nil)`.
`--hide-tags`	Do not display tags for tagged resources.
`--debug`	Prints internal debugging information. This is useful to assist us when troubleshooting problems.
`-?, --help, -h`	Displays Help.
`-`	If `-` is specified as an argument to one of the parameters, a list of arguments is read from standard input. This is useful for piping the output of one command into the input of another. Example: `ec2-describe-instances \| grep stopped \| cut -f 2 \| ec2-start-instances -`

Output

The command returns a table that contains the following information:

Attribute type identifier
ID of the AMI on which attributes are being modified
Action performed on the attribute
Attribute or attribute list item value type
Attribute or attribute list item value

Amazon EC2 command line tools display errors on stderr.

Examples

Example Request

This example makes the AMI public (i.e., so any AWS account can launch it).

PROMPT> ec2-modify-image-attribute ami-2bb65342 -l -a all
launchPermission   ami-2bb65342   ADD   group   all

Example Request

This example makes the AMI private (i.e., so only you as the owner can launch it).

PROMPT> ec2-modify-image-attribute ami-2bb65342 -l -r all
launchPermission  ami-2bb65342   REMOVE   group  all

Example Request

This example grants launch permission to the AWS account with ID 111122223333.

PROMPT> ec2-modify-image-attribute ami-2bb65342 -l -a 111122223333
launchPermission  ami-2bb65342  ADD  userId  111122223333

Example Request

This example removes launch permission from the AWS account with ID 111122223333.

PROMPT> ec2-modify-image-attribute ami-2bb65342 -l -r 111122223333
launchPermission  ami-2bb65342  REMOVE  userId  111122223333

Example Request

This example adds the 774F4FF8 product code to the ami-61a54008 AMI.

PROMPT> ec2-modify-image-attribute ami-61a54008 -p 774F4FF8
productcodes ami-61a54008   productCode  774F4FF8

Description

Syntax

Options

Common Options

Output

Examples

Example Request

Example Request

Example Request

Example Request

Example Request

Related Operations