ec2_describe_images {aws.ecx}

Describe Images

Description

Describe Images

Usage

ec2_describe_images(
  ExecutableBy = NULL,
  Filter = NULL,
  ImageId = NULL,
  Owner = NULL,
  DryRun = NULL,
  simplify = TRUE,
  others = list(),
  print_on_error = aws_get_print_on_error(),
  retry_time = aws_get_retry_time(),
  network_timeout = aws_get_network_timeout(),
  region = aws_get_region()
)

Arguments

ExecutableBy

List. Scopes the images by users with explicit launch permissions.[optional]

Filter

Named list where the name is the filter name and the value is the filter's value. The value can be a vector or a list object (see below)[optional]

ImageId

List. The image IDs. Default: Describes all images available to you. [optional]

Owner

List. Scopes the results to images with the specified owners.[optional]

DryRun

Logical. Checks whether you have the required permissions for the action, without actually making the request,...[optional]

simplify

Logical. Whether to simplify the result and handle nextToken in the response[optional]

others

Named list. The parameters that are not included in the function parameters and need to be added into the request[optional]

print_on_error

Logical. Whether to show an error message when a network error occurs.

retry_time

Integer. Number of retries for a REST request when encounter the network issue. If the request has been sent retry_time times but still not be able to get the response, an error will be thrown.

network_timeout

Numeric. Number of seconds to wait for a REST response until giving up. Can not be less than 1 ms.

region

Character. The region of the AWS service.

Value

A list object or a character vector

ExecutableBy

Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).

Filter

The filters.

• architecture - The image architecture (i386 \| x86_64 \| arm64).

• block-device-mapping.delete-on-termination - A Boolean value that indicates whether the Amazon EBS volume is deleted on instance termination.

• block-device-mapping.device-name - The device name specified in the block device mapping (for example, ⁠/dev/sdh⁠ or xvdh).

• block-device-mapping.snapshot-id - The ID of the snapshot used for the EBS volume.

• block-device-mapping.volume-size - The volume size of the EBS volume, in GiB.

• block-device-mapping.volume-type - The volume type of the EBS volume (gp2 \| io1 \| io2 \| st1 \| sc1 \| standard).

• block-device-mapping.encrypted - A Boolean that indicates whether the EBS volume is encrypted.

• description - The description of the image (provided during image creation).

• ena-support - A Boolean that indicates whether enhanced networking with ENA is enabled.

• hypervisor - The hypervisor type (ovm \| xen).

• image-id - The ID of the image.

• image-type - The image type (machine \| kernel \| ramdisk).

• is-public - A Boolean that indicates whether the image is public.

• kernel-id - The kernel ID.

• manifest-location - The location of the image manifest.

• name - The name of the AMI (provided during image creation).

• owner-alias - The owner alias (amazon \| aws-marketplace). The valid aliases are defined in an Amazon-maintained list. This is not the AWS account alias that can be set using the IAM console. We recommend that you use the Owner request parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.

• platform - The platform. To only list Windows-based AMIs, use windows.

• product-code - The product code.

• product-code.type - The type of the product code (devpay \| marketplace).

• ramdisk-id - The RAM disk ID.

• root-device-name - The device name of the root device volume (for example, ⁠/dev/sda1⁠).

• root-device-type - The type of the root device volume (ebs \| instance-store).

• state - The state of the image (available \| pending \| failed).

• state-reason-code - The reason code for the state change.

• state-reason-message - The message for the state change.

• sriov-net-support - A value of simple indicates that enhanced networking with the Intel 82599 VF interface is enabled.

• tag:\ - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• virtualization-type - The virtualization type (paravirtual \| hvm).

ImageId

The image IDs.

Default: Describes all images available to you.

Owner

Scopes the results to images with the specified owners. You can specify a combination of AWS account IDs, self, amazon, and aws-marketplace. If you omit this parameter, the results include all images for which you have launch permissions, regardless of ownership.

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.