DescribeImagesRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.ec2.model.Ec2Request
    - - software.amazon.awssdk.services.ec2.model.DescribeImagesRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeImagesRequest
extends Ec2Request
implements ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeImagesRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeImagesRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeImagesRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<String>`	`executableUsers()` Scopes the images by users with explicit launch permissions.
`List<Filter>`	`filters()` The filters.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasExecutableUsers()` Returns true if the ExecutableUsers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasFilters()` Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`int`	`hashCode()`
`boolean`	`hasImageIds()` Returns true if the ImageIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`boolean`	`hasOwners()` Returns true if the Owners property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<String>`	`imageIds()` The image IDs.
`List<String>`	`owners()` Filters the images by the owner.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeImagesRequest.Builder>`	`serializableBuilderClass()`
`DescribeImagesRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - hasExecutableUsers
```
public boolean hasExecutableUsers()
```
    Returns true if the ExecutableUsers property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - executableUsers
```
public List<String> executableUsers()
```
    Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasExecutableUsers() to see if a value was sent in this field.
    
    Returns:
    
    Scopes the images by users with explicit launch permissions. Specify an AWS account ID, self (the sender of the request), or all (public AMIs).
  - hasFilters
```
public boolean hasFilters()
```
    Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - filters
```
public List<Filter> filters()
```
    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 | 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 - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    - owner-id - The AWS account ID of the image owner.
    - 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:<key> - 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).
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasFilters() to see if a value was sent in this field.
    Returns:
    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 | 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 - String value from an Amazon-maintained list (amazon | aws-marketplace | microsoft) of snapshot owners. Not to be confused with the user-configured AWS account alias, which is set from the IAM console.
    
    owner-id - The AWS account ID of the image owner.
    
    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:<key> - 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).
  - hasImageIds
```
public boolean hasImageIds()
```
    Returns true if the ImageIds property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - imageIds
```
public List<String> imageIds()
```
    The image IDs.
    
    Default: Describes all images available to you.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasImageIds() to see if a value was sent in this field.
    
    Returns:
    
    The image IDs.
    
    Default: Describes all images available to you.
  - hasOwners
```
public boolean hasOwners()
```
    Returns true if the Owners property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.
  - owners
```
public List<String> owners()
```
    Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasOwners() to see if a value was sent in this field.
    
    Returns:
    
    Filters the images by the owner. Specify an AWS account ID, self (owner is the sender of the request), or an AWS owner alias (valid values are amazon | aws-marketplace | microsoft). Omitting this option returns all images for which you have launch permissions, regardless of ownership.
  - toBuilder
```
public DescribeImagesRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
    
    Specified by:
    
    toBuilder in class Ec2Request
  - builder
```
public static DescribeImagesRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeImagesRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeImagesRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasExecutableUsers

executableUsers

hasFilters

filters

hasImageIds

imageIds

hasOwners

owners

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields