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`	`dryRun()` Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.
`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()` For responses, this returns true if the service returned a value for the ExecutableUsers property.
`boolean`	`hasFilters()` For responses, this returns true if the service returned a value for the Filters property.
`int`	`hashCode()`
`boolean`	`hasImageIds()` For responses, this returns true if the service returned a value for the ImageIds property.
`boolean`	`hasOwners()` For responses, this returns true if the service returned a value for the Owners property.
`List<String>`	`imageIds()` The image IDs.
`Boolean`	`includeDeprecated()` Specifies whether to include deprecated AMIs.
`Boolean`	`includeDisabled()` Specifies whether to include disabled AMIs.
`Integer`	`maxResults()` The maximum number of items to return for this request.
`String`	`nextToken()` The token returned from a previous paginated request.
`List<String>`	`owners()` Scopes the results to images with the specified owners.
`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 final boolean hasExecutableUsers()
```
    For responses, this returns true if the service returned a value for the ExecutableUsers property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - executableUsers
```
public final List<String> executableUsers()
```
    Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
    - If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
    - If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
    - If you specify all, all public AMIs are returned.
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasExecutableUsers() method.
    Returns:
    Scopes the images by users with explicit launch permissions. Specify an Amazon Web Services account ID, self (the sender of the request), or all (public AMIs).
    
    If you specify an Amazon Web Services account ID that is not your own, only AMIs shared with that specific Amazon Web Services account ID are returned. However, AMIs that are shared with the account’s organization or organizational unit (OU) are not returned.
    
    If you specify self or your own Amazon Web Services account ID, AMIs shared with your account are returned. In addition, AMIs that are shared with the organization or OU of which you are member are also returned.
    
    If you specify all, all public AMIs are returned.
  - hasFilters
```
public final boolean hasFilters()
```
    For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - filters
```
public final List<Filter> filters()
```
    The filters.
    - architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
    - 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 Amazon EBS volume.
    - block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
    - block-device-mapping.volume-type - The volume type of the Amazon EBS volume (io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
    - block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
    - creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard ( *), for example, 2021-09-29T*, which matches an entire day.
    - 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 Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
    - platform - The platform. The only supported value is windows.
    - product-code - The product code.
    - product-code.type - The type of the product code (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).
    - source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.
    - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasFilters() method.
    Returns:
    The filters.
    
    architecture - The image architecture (i386 | x86_64 | arm64 | x86_64_mac | arm64_mac).
    
    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 Amazon EBS volume.
    
    block-device-mapping.volume-size - The volume size of the Amazon EBS volume, in GiB.
    
    block-device-mapping.volume-type - The volume type of the Amazon EBS volume ( io1 | io2 | gp2 | gp3 | sc1 | st1 | standard).
    
    block-device-mapping.encrypted - A Boolean that indicates whether the Amazon EBS volume is encrypted.
    
    creation-date - The time when the image was created, in the ISO 8601 format in the UTC time zone (YYYY-MM-DDThh:mm:ss.sssZ), for example, 2021-09-29T11:04:43.305Z. You can use a wildcard (*), for example, 2021-09-29T*, which matches an entire day.
    
    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 Amazon Web Services 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 Amazon Web Services account ID of the owner. We recommend that you use the Owner request parameter instead of this filter.
    
    platform - The platform. The only supported value is windows.
    
    product-code - The product code.
    
    product-code.type - The type of the product code (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).
    
    source-instance-id - The ID of the instance that the AMI was created from if the AMI was created using CreateImage. This filter is applicable only if the AMI was created using CreateImage.
    
    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 final boolean hasImageIds()
```
    For responses, this returns true if the service returned a value for the ImageIds property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - imageIds
```
public final 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasImageIds() method.
    
    Returns:
    
    The image IDs.
    
    Default: Describes all images available to you.
  - hasOwners
```
public final boolean hasOwners()
```
    For responses, this returns true if the service returned a value for the Owners property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - owners
```
public final List<String> owners()
```
    Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services 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.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasOwners() method.
    
    Returns:
    
    Scopes the results to images with the specified owners. You can specify a combination of Amazon Web Services 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.
  - includeDeprecated
```
public final Boolean includeDeprecated()
```
    Specifies whether to include deprecated AMIs.
    
    Default: No deprecated AMIs are included in the response.
    
    If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.
    
    Returns:
    
    Specifies whether to include deprecated AMIs.
    
    Default: No deprecated AMIs are included in the response.
    
    If you are the AMI owner, all deprecated AMIs appear in the response regardless of what you specify for this parameter.
  - includeDisabled
```
public final Boolean includeDisabled()
```
    Specifies whether to include disabled AMIs.
    
    Default: No disabled AMIs are included in the response.
    
    Returns:
    
    Specifies whether to include disabled AMIs.
    
    Default: No disabled AMIs are included in the response.
  - dryRun
```
public final Boolean 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.
    
    Returns:
    
    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.
  - maxResults
```
public final Integer maxResults()
```
    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
    
    Returns:
    
    The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see Pagination.
  - nextToken
```
public final String nextToken()
```
    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
    
    Returns:
    
    The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
  - 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final 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

includeDeprecated

includeDisabled

dryRun

maxResults

nextToken

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields