ModifyImageAttribute
Modifies the specified attribute of the specified AMI. You can specify only one attribute at a time.
To specify the attribute, you can use theAttribute parameter, or one of the following parameters:Description,ImdsSupport, orLaunchPermission.
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.
Request Parameters
The following parameters are for this specific action. For more information about required and optional parameters that are common to all actions, seeCommon Query Parameters.
- Attribute
The name of the attribute to modify.
Valid values:
description|imdsSupport|launchPermissionType: String
Required: No
- Description
A new description for the AMI.
Type:AttributeValue object
Required: No
- 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 isUnauthorizedOperation.Type: Boolean
Required: No
- ImageId
The ID of the AMI.
Type: String
Required: Yes
- ImdsSupport
Set to
v2.0to indicate that IMDSv2 is specified in the AMI. Instances launched from this AMI will haveHttpTokensautomatically set torequiredso that, by default, the instance requires that IMDSv2 is used when requesting instance metadata. In addition,HttpPutResponseHopLimitis set to2. For more information, seeConfigure the AMI in theAmazon EC2 User Guide.Do not use this parameter unless your AMI software supports IMDSv2. After you set the value to
v2.0, you can't undo it. The only way to “reset” your AMI is to create a new AMI from the underlying snapshot.Type:AttributeValue object
Required: No
- LaunchPermission
A new launch permission for the AMI.
Type:LaunchPermissionModifications object
Required: No
- OperationType
The operation type. This parameter can be used only when the
Attributeparameter islaunchPermission.Type: String
Valid Values:
add | removeRequired: No
- OrganizationalUnitArn.N
The Amazon Resource Name (ARN) of an organizational unit (OU). This parameter can be used only when the
Attributeparameter islaunchPermission.Type: Array of strings
Required: No
- OrganizationArn.N
The Amazon Resource Name (ARN) of an organization. This parameter can be used only when the
Attributeparameter islaunchPermission.Type: Array of strings
Required: No
- ProductCode.N
Not supported.
Type: Array of strings
Required: No
- UserGroup.N
The user groups. This parameter can be used only when the
Attributeparameter islaunchPermission.Type: Array of strings
Required: No
- UserId.N
The AWS account IDs. This parameter can be used only when the
Attributeparameter islaunchPermission.Type: Array of strings
Required: No
- Value
The value of the attribute being modified. This parameter can be used only when the
Attributeparameter isdescriptionorimdsSupport.Type: String
Required: No
Response Elements
The following elements are returned by the service.
- requestId
The ID of the request.
Type: String
- return
Is
trueif the request succeeds, and an error otherwise.Type: Boolean
Errors
For information about the errors that are common to all actions, seeCommon client error codes.
Examples
Example 1
This example makes the AMI public (for example, so any AWS account can use it).
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&LaunchPermission.Add.1.Group=all&AUTHPARAMSSample Response
<ModifyImageAttributeResponse xmlns="http://ec2.amazonaws.com/doc/2016-11-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <return>true</return></ModifyImageAttributeResponse>Example 2
This example makes the AMI private (for example, so that only you as the owner can use it).
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&LaunchPermission.Remove.1.Group=all&AUTHPARAMSExample 3
This example grants launch permission to the AWS account with ID111122223333.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&LaunchPermission.Add.1.UserId=111122223333&AUTHPARAMSExample 4
This example adds the774F4FF8 product code to theami-61a54008 AMI.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&ProductCode.1=774F4FF8&AUTHPARAMSExample 5
This example changes the description of the AMI toNew Description.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&Description.Value=New Description&AUTHPARAMSExample 6
This example sets the AMI to IMDSv2 only. Instances created from this AMI will require that IMDSv2 is used when requesting instance metadata.
Note that after you set the value tov2.0, you can't undo it.
Sample Request
https://ec2.amazonaws.com/?Action=ModifyImageAttribute&ImageId=ami-61a54008&ImdsSupport.Value=v2.0&AUTHPARAMSSee Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
