public class DescribeImagesRequest extends AmazonWebServiceRequest implements java.io.Serializable, DryRunSupportedRequest<DescribeImagesRequest>
DescribeImages operation
.
Describes one or more of the images (AMIs, AKIs, and ARIs) available to you. Images available to you include public images, private images that you own, and private images owned by other AWS accounts but for which you have explicit launch permissions.
NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.
Constructor and Description |
---|
DescribeImagesRequest() |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object obj) |
Request<DescribeImagesRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
java.util.List<java.lang.String> |
getExecutableUsers()
Scopes the images by users with explicit launch permissions.
|
java.util.List<Filter> |
getFilters()
One or more filters.
|
java.util.List<java.lang.String> |
getImageIds()
One or more image IDs.
|
java.util.List<java.lang.String> |
getOwners()
Filters the images by the owner.
|
int |
hashCode() |
void |
setExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
Scopes the images by users with explicit launch permissions.
|
void |
setFilters(java.util.Collection<Filter> filters)
One or more filters.
|
void |
setImageIds(java.util.Collection<java.lang.String> imageIds)
One or more image IDs.
|
void |
setOwners(java.util.Collection<java.lang.String> owners)
Filters the images by the owner.
|
java.lang.String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeImagesRequest |
withExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
Scopes the images by users with explicit launch permissions.
|
DescribeImagesRequest |
withExecutableUsers(java.lang.String... executableUsers)
Scopes the images by users with explicit launch permissions.
|
DescribeImagesRequest |
withFilters(java.util.Collection<Filter> filters)
One or more filters.
|
DescribeImagesRequest |
withFilters(Filter... filters)
One or more filters.
|
DescribeImagesRequest |
withImageIds(java.util.Collection<java.lang.String> imageIds)
One or more image IDs.
|
DescribeImagesRequest |
withImageIds(java.lang.String... imageIds)
One or more image IDs.
|
DescribeImagesRequest |
withOwners(java.util.Collection<java.lang.String> owners)
Filters the images by the owner.
|
DescribeImagesRequest |
withOwners(java.lang.String... owners)
Filters the images by the owner.
|
clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector
public java.util.List<java.lang.String> getImageIds()
Default: Describes all images available to you.
Default: Describes all images available to you.
public void setImageIds(java.util.Collection<java.lang.String> imageIds)
Default: Describes all images available to you.
imageIds
- One or more image IDs. Default: Describes all images available to you.
public DescribeImagesRequest withImageIds(java.lang.String... imageIds)
Default: Describes all images available to you.
Returns a reference to this object so that method calls can be chained together.
imageIds
- One or more image IDs. Default: Describes all images available to you.
public DescribeImagesRequest withImageIds(java.util.Collection<java.lang.String> imageIds)
Default: Describes all images available to you.
Returns a reference to this object so that method calls can be chained together.
imageIds
- One or more image IDs. Default: Describes all images available to you.
public java.util.List<java.lang.String> getOwners()
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.public void setOwners(java.util.Collection<java.lang.String> owners)
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.owners
- Filters the images by the owner. Specify an AWS account ID,
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.public DescribeImagesRequest withOwners(java.lang.String... owners)
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.
Returns a reference to this object so that method calls can be chained together.
owners
- Filters the images by the owner. Specify an AWS account ID,
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.public DescribeImagesRequest withOwners(java.util.Collection<java.lang.String> owners)
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.
Returns a reference to this object so that method calls can be chained together.
owners
- Filters the images by the owner. Specify an AWS account ID,
amazon
(owner is Amazon), aws-marketplace
(owner is AWS Marketplace), self
(owner is the sender of
the request). Omitting this option returns all images for which you
have launch permissions, regardless of ownership.public java.util.List<java.lang.String> getExecutableUsers()
self
(the sender of the request), or
all
(public AMIs).self
(the sender of the request), or
all
(public AMIs).public void setExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
self
(the sender of the request), or
all
(public AMIs).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).public DescribeImagesRequest withExecutableUsers(java.lang.String... executableUsers)
self
(the sender of the request), or
all
(public AMIs).
Returns a reference to this object so that method calls can be chained together.
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).public DescribeImagesRequest withExecutableUsers(java.util.Collection<java.lang.String> executableUsers)
self
(the sender of the request), or
all
(public AMIs).
Returns a reference to this object so that method calls can be chained together.
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).public java.util.List<Filter> getFilters()
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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
public void setFilters(java.util.Collection<Filter> 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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
public DescribeImagesRequest withFilters(Filter... 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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
Returns a reference to this object so that method calls can be chained together.
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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
public DescribeImagesRequest withFilters(java.util.Collection<Filter> 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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
Returns a reference to this object so that method calls can be chained together.
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 for
the EBS volume (for example, /dev/sdh
).
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).
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 AWS account alias (for example,
amazon
).
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 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.
tag
:key=value - The key/value
combination of a tag assigned to the resource.
tag-key
- The key of a tag assigned to the resource.
This filter is independent of the tag-value filter. For example, if
you use both the filter "tag-key=Purpose" and the filter
"tag-value=X", you get any resources assigned both the tag key Purpose
(regardless of what the tag's value is), and the tag value X
(regardless of what the tag's key is). If you want to list only
resources where Purpose is X, see the
tag
:key=value filter.
tag-value
- The value of a tag assigned to the
resource. This filter is independent of the tag-key
filter.
virtualization-type
- The
virtualization type (paravirtual
| hvm
).
public Request<DescribeImagesRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeImagesRequest>
public java.lang.String toString()
toString
in class java.lang.Object
Object.toString()
public int hashCode()
hashCode
in class java.lang.Object
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
Copyright © 2018 Amazon Web Services, Inc. All Rights Reserved.