[ 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 or LaunchPermission .

Images with an Amazon Web Services 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]
[--organization-arns <value>]
[--organizational-unit-arns <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--attribute (string)

The name of the attribute to modify.

Valid values: description | launchPermission

--description (structure)

A new description for the AMI.

Value -> (string)

The attribute value. The value is case-sensitive.

--image-id (string)

The ID of the AMI.

--launch-permission (structure)

A new launch permission for the AMI.

Add -> (list)

The Amazon Web Services account ID, organization ARN, or OU ARN to add to the list of launch permissions for the AMI.

(structure)

Describes a launch permission.

Group -> (string)

The name of the group.

UserId -> (string)

The Amazon Web Services account ID.

Constraints: Up to 10 000 account IDs can be specified in a single request.

OrganizationArn -> (string)

The Amazon Resource Name (ARN) of an organization.

OrganizationalUnitArn -> (string)

The Amazon Resource Name (ARN) of an organizational unit (OU).

Remove -> (list)

The Amazon Web Services account ID, organization ARN, or OU ARN to remove from the list of launch permissions for the AMI.

(structure)

Describes a launch permission.

Group -> (string)

The name of the group.

UserId -> (string)

The Amazon Web Services account ID.

Constraints: Up to 10 000 account IDs can be specified in a single request.

OrganizationArn -> (string)

The Amazon Resource Name (ARN) of an organization.

OrganizationalUnitArn -> (string)

The Amazon Resource Name (ARN) of an organizational unit (OU).

Shorthand Syntax:

Add=[{Group=string,UserId=string,OrganizationArn=string,OrganizationalUnitArn=string},{Group=string,UserId=string,OrganizationArn=string,OrganizationalUnitArn=string}],Remove=[{Group=string,UserId=string,OrganizationArn=string,OrganizationalUnitArn=string},{Group=string,UserId=string,OrganizationArn=string,OrganizationalUnitArn=string}]

JSON Syntax:

{
  "Add": [
    {
      "Group": "all",
      "UserId": "string",
      "OrganizationArn": "string",
      "OrganizationalUnitArn": "string"
    }
    ...
  ],
  "Remove": [
    {
      "Group": "all",
      "UserId": "string",
      "OrganizationArn": "string",
      "OrganizationalUnitArn": "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)

Not supported.

(string)

Syntax:

"string" "string" ...

--user-groups (list)

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

(string)

Syntax:

"string" "string" ...

--user-ids (list)

The Amazon Web Services account IDs. This parameter can be used only when the Attribute parameter is launchPermission .

(string)

Syntax:

"string" "string" ...

--value (string)

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

--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 .

--organization-arns (list)

The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the Attribute parameter is launchPermission .

(string)

Syntax:

"string" "string" ...

--organizational-unit-arns (list)

The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the Attribute parameter is launchPermission .

(string)

Syntax:

"string" "string" ...

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

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