Describe Image Attribute
ec2_describe_image_attribute | R Documentation |
Describes the specified attribute of the specified AMI¶
Description¶
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.
Usage¶
Arguments¶
Attribute
[required] The AMI attribute.
Note: The
blockDeviceMapping
attribute is deprecated. Using this attribute returns theClient.AuthFailure
error. To get information about the block device mappings for an AMI, use thedescribe_images
action.ImageId
[required] The ID of the AMI.
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
.
Value¶
A list with the following syntax:
list(
BlockDeviceMappings = list(
list(
DeviceName = "string",
VirtualName = "string",
Ebs = list(
DeleteOnTermination = TRUE|FALSE,
Iops = 123,
SnapshotId = "string",
VolumeSize = 123,
VolumeType = "standard"|"io1"|"io2"|"gp2"|"sc1"|"st1"|"gp3",
KmsKeyId = "string",
Throughput = 123,
OutpostArn = "string",
Encrypted = TRUE|FALSE
),
NoDevice = "string"
)
),
ImageId = "string",
LaunchPermissions = list(
list(
Group = "all",
UserId = "string",
OrganizationArn = "string",
OrganizationalUnitArn = "string"
)
),
ProductCodes = list(
list(
ProductCodeId = "string",
ProductCodeType = "devpay"|"marketplace"
)
),
Description = list(
Value = "string"
),
KernelId = list(
Value = "string"
),
RamdiskId = list(
Value = "string"
),
SriovNetSupport = list(
Value = "string"
),
BootMode = list(
Value = "string"
),
TpmSupport = list(
Value = "string"
),
UefiData = list(
Value = "string"
),
LastLaunchedTime = list(
Value = "string"
),
ImdsSupport = list(
Value = "string"
),
DeregistrationProtection = list(
Value = "string"
)
)
Request syntax¶
svc$describe_image_attribute(
Attribute = "description"|"kernel"|"ramdisk"|"launchPermission"|"productCodes"|"blockDeviceMapping"|"sriovNetSupport"|"bootMode"|"tpmSupport"|"uefiData"|"lastLaunchedTime"|"imdsSupport"|"deregistrationProtection",
ImageId = "string",
DryRun = TRUE|FALSE
)