AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ModifyImageAttribute operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.EC2.AmazonEC2Request
      Amazon.EC2.Model.ModifyImageAttributeRequest

Namespace: Amazon.EC2.Model
Assembly: AWSSDK.EC2.dll
Version: 3.x.y.z

Syntax

C#
public class ModifyImageAttributeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The ModifyImageAttributeRequest type exposes the following members

Constructors

NameDescription
Public Method ModifyImageAttributeRequest()

Empty constructor used to set properties independently even when a simple constructor is available

Public Method ModifyImageAttributeRequest(string, string)

Instantiates ModifyImageAttributeRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Attribute System.String

Gets and sets the property Attribute.

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

Public Property Description System.String

Gets and sets the property Description.

A new description for the AMI.

Public Property ImageId System.String

Gets and sets the property ImageId.

The ID of the AMI.

Public Property LaunchPermission Amazon.EC2.Model.LaunchPermissionModifications

Gets and sets the property LaunchPermission.

A new launch permission for the AMI.

Public Property OperationType Amazon.EC2.OperationType

Gets and sets the property OperationType.

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

Public Property ProductCodes System.Collections.Generic.List<System.String>

Gets and sets the property ProductCodes.

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

Public Property UserGroups System.Collections.Generic.List<System.String>

Gets and sets the property UserGroups.

One or more user groups. This parameter can be used only when the Attribute parameter is launchPermission.

Public Property UserIds System.Collections.Generic.List<System.String>

Gets and sets the property UserIds.

One or more AWS account IDs. This parameter can be used only when the Attribute parameter is launchPermission.

Public Property Value System.String

Gets and sets the property Value.

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

Examples

This example makes the specified AMI public.

To make an AMI public


var response = client.ModifyImageAttribute(new ModifyImageAttributeRequest 
{
    ImageId = "ami-5731123e",
    LaunchPermission = new LaunchPermissionModifications { Add = new List {
        new LaunchPermission { Group = "all" }
    } }
});


            

This example grants launch permissions for the specified AMI to the specified AWS account.

To grant launch permissions


var response = client.ModifyImageAttribute(new ModifyImageAttributeRequest 
{
    ImageId = "ami-5731123e",
    LaunchPermission = new LaunchPermissionModifications { Add = new List {
        new LaunchPermission { UserId = "123456789012" }
    } }
});


            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms