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 DescribeImageAttribute operation. Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

The order of the elements in the response, including those within nested structures, might vary. Applications should not assume the elements appear in a particular order.

Inheritance Hierarchy

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

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

Syntax

C# 
public class DescribeImageAttributeRequest : AmazonEC2Request
         IAmazonWebServiceRequest

The DescribeImageAttributeRequest type exposes the following members

Constructors

NameDescription
Public Method DescribeImageAttributeRequest()

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

Public Method DescribeImageAttributeRequest(string, ImageAttributeName)

Instantiates DescribeImageAttributeRequest with the parameterized properties

Properties

NameTypeDescription
Public Property Attribute Amazon.EC2.ImageAttributeName

Gets and sets the property Attribute.

The AMI attribute.

Note: The blockDeviceMapping attribute is deprecated. Using this attribute returns the Client.AuthFailure error. To get information about the block device mappings for an AMI, use the DescribeImages action.

Public Property ImageId System.String

Gets and sets the property ImageId.

The ID of the AMI.

Examples

This example describes the launch permissions for the specified AMI.

To describe the launch permissions for an AMI


var client = new AmazonEC2Client();
var response = client.DescribeImageAttribute(new DescribeImageAttributeRequest 
{
    Attribute = "launchPermission",
    ImageId = "ami-5731123e"
});

string imageId = response.ImageId;
List<LaunchPermission> launchPermissions = response.LaunchPermissions;

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5