ec2_describe_image_attribute: Describes the specified attribute of the specified AMI

Description Usage Arguments Value Request syntax Examples

View source: R/ec2_operations.R

Description

Describes the specified attribute of the specified AMI. You can specify only one attribute at a time.

Usage

1
ec2_describe_image_attribute(Attribute, ImageId, DryRun)

Arguments

Attribute

[required] The AMI attribute.

Note: Depending on your account privileges, the blockDeviceMapping attribute may return a Client.AuthFailure error. If this happens, use describe_images to get information about the block device mapping for the AMI.

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 is UnauthorizedOperation.

Value

A list with the following syntax:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
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,
        Encrypted = TRUE|FALSE
      ),
      NoDevice = "string"
    )
  ),
  ImageId = "string",
  LaunchPermissions = list(
    list(
      Group = "all",
      UserId = "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"
  )
)

Request syntax

1
2
3
4
5
svc$describe_image_attribute(
  Attribute = "description"|"kernel"|"ramdisk"|"launchPermission"|"productCodes"|"blockDeviceMapping"|"sriovNetSupport",
  ImageId = "string",
  DryRun = TRUE|FALSE
)

Examples

1
2
3
4
5
6
7
8
## Not run: 
# This example describes the launch permissions for the specified AMI.
svc$describe_image_attribute(
  Attribute = "launchPermission",
  ImageId = "ami-5731123e"
)

## End(Not run)

paws.compute documentation built on March 7, 2021, 5:10 p.m.