DescribeImagesRequest.Builder (AWS SDK for Java

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>, Ec2Request.Builder, SdkBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

DescribeImagesRequest
```
public static interface DescribeImagesRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeImagesRequest.Builder,DescribeImagesRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`DescribeImagesRequest.Builder`	`executableUsers(Collection<String> executableUsers)` Scopes the images by users with explicit launch permissions.
`DescribeImagesRequest.Builder`	`executableUsers(String... executableUsers)` Scopes the images by users with explicit launch permissions.
`DescribeImagesRequest.Builder`	`filters(Collection<Filter> filters)` One or more filters.
`DescribeImagesRequest.Builder`	`filters(Consumer<Filter.Builder>... filters)` One or more filters.
`DescribeImagesRequest.Builder`	`filters(Filter... filters)` One or more filters.
`DescribeImagesRequest.Builder`	`imageIds(Collection<String> imageIds)` One or more image IDs.
`DescribeImagesRequest.Builder`	`imageIds(String... imageIds)` One or more image IDs.
`DescribeImagesRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)` Add an optional request override configuration.
`DescribeImagesRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)` Add an optional request override configuration.
`DescribeImagesRequest.Builder`	`owners(Collection<String> owners)` Filters the images by the owner.
`DescribeImagesRequest.Builder`	`owners(String... owners)` Filters the images by the owner.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
sdkFields

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

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - executableUsers
```
DescribeImagesRequest.Builder executableUsers(Collection<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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - executableUsers
```
DescribeImagesRequest.Builder executableUsers(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).
    
    Parameters:
    
    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).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
DescribeImagesRequest.Builder filters(Collection<Filter> filters)
```
    One or more filters.
    - architecture - The image architecture (i386 | x86_64).
    - 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).
    - 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).
    Parameters:
    filters - One or more filters.
    
    architecture - The image architecture (i386 | x86_64).
    
    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).
    
    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).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
DescribeImagesRequest.Builder filters(Filter... filters)
```
    One or more filters.
    - architecture - The image architecture (i386 | x86_64).
    - 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).
    - 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).
    Parameters:
    filters - One or more filters.
    
    architecture - The image architecture (i386 | x86_64).
    
    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).
    
    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).
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - filters
```
DescribeImagesRequest.Builder filters(Consumer<Filter.Builder>... filters)
```
    One or more filters.
    - architecture - The image architecture (i386 | x86_64).
    - 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).
    - 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).
    This is a convenience that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #filters(List).
    Parameters:
    
    filters - a consumer that will call methods on List.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #filters(List)
  - imageIds
```
DescribeImagesRequest.Builder imageIds(Collection<String> imageIds)
```
    One or more image IDs.
    
    Default: Describes all images available to you.
    
    Parameters:
    
    imageIds - One or more image IDs.
    
    Default: Describes all images available to you.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - imageIds
```
DescribeImagesRequest.Builder imageIds(String... imageIds)
```
    One or more image IDs.
    
    Default: Describes all images available to you.
    
    Parameters:
    
    imageIds - One or more image IDs.
    
    Default: Describes all images available to you.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - owners
```
DescribeImagesRequest.Builder owners(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - owners
```
DescribeImagesRequest.Builder owners(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - overrideConfiguration
```
DescribeImagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    overrideConfiguration - The override configuration.
    
    Returns:
    
    This object for method chaining.
  - overrideConfiguration
```
DescribeImagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Description copied from interface: AwsRequest.Builder
    
    Add an optional request override configuration.
    
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
    
    Parameters:
    
    builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
    
    Returns:
    
    This object for method chaining.

Interface DescribeImagesRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

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

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

Method Detail

executableUsers

executableUsers

filters

filters

filters

imageIds

imageIds

owners

owners

overrideConfiguration

overrideConfiguration