There are more AWS SDK examples available in the AWS Doc SDK Examples
Use DescribeImageAttribute with a CLI
The following code examples show how to use DescribeImageAttribute.
- CLI
-
- AWS CLI
-
Example 1: To describe the launch permissions for an AMI
The following
describe-image-attributeexample describes the launch permissions for the specified AMI.aws ec2 describe-image-attribute \ --image-idami-5731123e\ --attributelaunchPermissionOutput:
{ "LaunchPermissions": [ { "UserId": "123456789012" } ], "ImageId": "ami-5731123e" }For more information, see Share an AMI with specific AWS accounts in the Amazon EC2 User Guide.
Example 2: To describe the product codes for an AMI
The following
describe-image-attributeexample describes the product codes for the specified AMI. Note that this AMI has no product codes.aws ec2 describe-image-attribute \ --image-idami-5731123e\ --attributeproductCodesOutput:
{ "ProductCodes": [], "ImageId": "ami-5731123e" }For more information, see Paid AMIs in the AWS Marketplace for Amazon EC2 instances in the Amazon EC2 User Guide.
-
For API details, see DescribeImageAttribute
in AWS CLI Command Reference.
-
- PowerShell
-
- Tools for PowerShell V4
-
Example 1: This example gets the description for the specified AMI.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute descriptionOutput:
BlockDeviceMappings : {} Description : My image description ImageId : ami-12345678 KernelId : LaunchPermissions : {} ProductCodes : {} RamdiskId : SriovNetSupport :Example 2: This example gets the launch permissions for the specified AMI.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermissionOutput:
BlockDeviceMappings : {} Description : ImageId : ami-12345678 KernelId : LaunchPermissions : {all} ProductCodes : {} RamdiskId : SriovNetSupport :Example 3: This example test whether enhanced networking is enabled.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute sriovNetSupportOutput:
BlockDeviceMappings : {} Description : ImageId : ami-12345678 KernelId : LaunchPermissions : {} ProductCodes : {} RamdiskId : SriovNetSupport : simple-
For API details, see DescribeImageAttribute in AWS Tools for PowerShell Cmdlet Reference (V4).
-
- Tools for PowerShell V5
-
Example 1: This example gets the description for the specified AMI.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute descriptionOutput:
BlockDeviceMappings : {} Description : My image description ImageId : ami-12345678 KernelId : LaunchPermissions : {} ProductCodes : {} RamdiskId : SriovNetSupport :Example 2: This example gets the launch permissions for the specified AMI.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute launchPermissionOutput:
BlockDeviceMappings : {} Description : ImageId : ami-12345678 KernelId : LaunchPermissions : {all} ProductCodes : {} RamdiskId : SriovNetSupport :Example 3: This example test whether enhanced networking is enabled.
Get-EC2ImageAttribute -ImageId ami-12345678 -Attribute sriovNetSupportOutput:
BlockDeviceMappings : {} Description : ImageId : ami-12345678 KernelId : LaunchPermissions : {} ProductCodes : {} RamdiskId : SriovNetSupport : simple-
For API details, see DescribeImageAttribute in AWS Tools for PowerShell Cmdlet Reference (V5).
-