com.amazonaws.services.ec2.model

## クラス DescribeImagesRequest

- java.lang.Object
- - com.amazonaws.AmazonWebServiceRequest
  - - com.amazonaws.services.ec2.model.DescribeImagesRequest

- すべての実装されたインタフェース:
    java.io.Serializable

      public class DescribeImagesRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeImages operation`.

  The DescribeImages operation returns information about AMIs, AKIs, and ARIs available to the user. Information returned includes image type, product codes, architecture, and kernel and RAM disk IDs. Images available to the user include public images available for any user to launch, private images owned by the user making the request, and private images owned by other users for which the user has explicit launch permissions.

  Launch permissions fall into three categories:

  - Public: The owner of the AMI granted launch permissions for the AMI to the all group. All users have launch permissions for these AMIs.
  - Explicit: The owner of the AMI granted launch permissions to a specific user.
  - Implicit: A user has implicit launch permissions for all AMIs he or she owns.

  The list of AMIs returned can be modified by specifying AMI IDs, AMI owners, or users with launch permissions. If no options are specified, Amazon EC2 returns all AMIs for which the user has launch permissions.

  If you specify one or more AMI IDs, only AMIs that have the specified IDs are returned. If you specify an invalid AMI ID, a fault is returned. If you specify an AMI ID for which you do not have access, it will not be included in the returned results.

  If you specify one or more AMI owners, only AMIs from the specified owners and for which you have access are returned. The results can include the account IDs of the specified owners, amazon for AMIs owned by Amazon or self for AMIs that you own.

  If you specify a list of executable users, only users that have launch permissions for the AMIs are returned. You can specify account IDs (if you own the AMI(s)), self for AMIs for which you own or have explicit permissions, or all for public AMIs.

  NOTE: Deregistered images are included in the returned results for an unspecified interval after deregistration.

  関連項目:
    `AmazonEC2.describeImages(DescribeImagesRequest)`, 直列化された形式

- - ### コンストラクタの概要

    コンストラクタ
    コンストラクタと説明
    `DescribeImagesRequest()`

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.util.List<java.lang.String>` | `getExecutableUsers()` An optional list of users whose launch permissions will be used to scope the described AMIs.
    `java.util.List<Filter>` | `getFilters()` A list of filters used to match properties for Images.
    `java.util.List<java.lang.String>` | `getImageIds()` An optional list of the AMI IDs to describe.
    `java.util.List<java.lang.String>` | `getOwners()` An optional list of owners by which to scope the described AMIs.
    `int` | `hashCode()`
    `void` | `setExecutableUsers(java.util.Collection<java.lang.String> executableUsers)` An optional list of users whose launch permissions will be used to scope the described AMIs.
    `void` | `setFilters(java.util.Collection<Filter> filters)` A list of filters used to match properties for Images.
    `void` | `setImageIds(java.util.Collection<java.lang.String> imageIds)` An optional list of the AMI IDs to describe.
    `void` | `setOwners(java.util.Collection<java.lang.String> owners)` An optional list of owners by which to scope the described AMIs.
    `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)` An optional list of users whose launch permissions will be used to scope the described AMIs.
    `DescribeImagesRequest` | `withExecutableUsers(java.lang.String... executableUsers)` An optional list of users whose launch permissions will be used to scope the described AMIs.
    `DescribeImagesRequest` | `withFilters(java.util.Collection<Filter> filters)` A list of filters used to match properties for Images.
    `DescribeImagesRequest` | `withFilters(Filter... filters)` A list of filters used to match properties for Images.
    `DescribeImagesRequest` | `withImageIds(java.util.Collection<java.lang.String> imageIds)` An optional list of the AMI IDs to describe.
    `DescribeImagesRequest` | `withImageIds(java.lang.String... imageIds)` An optional list of the AMI IDs to describe.
    `DescribeImagesRequest` | `withOwners(java.util.Collection<java.lang.String> owners)` An optional list of owners by which to scope the described AMIs.
    `DescribeImagesRequest` | `withOwners(java.lang.String... owners)` An optional list of owners by which to scope the described AMIs.

    - ### クラスから継承されたメソッド com.amazonaws.AmazonWebServiceRequest

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

    - ### クラスから継承されたメソッド java.lang.Object

      `clone, finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### コンストラクタの詳細

    - #### DescribeImagesRequest

          public DescribeImagesRequest()

  - ### メソッドの詳細

    - #### getImageIds

          public java.util.List<java.lang.String> getImageIds()

      An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
      戻り値:
        An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

    - #### setImageIds

          public void setImageIds(java.util.Collection<java.lang.String> imageIds)

      An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.
      パラメータ:
        `imageIds` - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

    - #### withImageIds

          public DescribeImagesRequest withImageIds(java.lang.String... imageIds)

      An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `imageIds` - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

    - #### withImageIds

          public DescribeImagesRequest withImageIds(java.util.Collection<java.lang.String> imageIds)

      An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `imageIds` - An optional list of the AMI IDs to describe. If not specified, all AMIs will be described.

    - #### getOwners

          public java.util.List<java.lang.String> getOwners()

      An optional list of owners by which to scope the described AMIs. Valid values are:
      `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

      The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

      戻り値:
        An optional list of owners by which to scope the described AMIs. Valid values are:
        `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

        The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

    - #### setOwners

          public void setOwners(java.util.Collection<java.lang.String> owners)

      An optional list of owners by which to scope the described AMIs. Valid values are:
      `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

      The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

      パラメータ:
        `owners` - An optional list of owners by which to scope the described AMIs. Valid values are:
        `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

        The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

    - #### withOwners

          public DescribeImagesRequest withOwners(java.lang.String... owners)

      An optional list of owners by which to scope the described AMIs. Valid values are:
      `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

      The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `owners` - An optional list of owners by which to scope the described AMIs. Valid values are:
        `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

        The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

    - #### withOwners

          public DescribeImagesRequest withOwners(java.util.Collection<java.lang.String> owners)

      An optional list of owners by which to scope the described AMIs. Valid values are:
      `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

      The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `owners` - An optional list of owners by which to scope the described AMIs. Valid values are:
        `self` : AMIs owned by you AWS account ID : AMIs owned by this account ID `aws-marketplace` : AMIs owned by the AWS Marketplace `amazon` : AMIs owned by Amazon `all` : Do not scope the AMIs returned by owner

        The values `self`, `aws-marketplace`, `amazon`, and `all` are literals.

    - #### getExecutableUsers

          public java.util.List<java.lang.String> getExecutableUsers()

      An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
      `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

      The values `self` and `all` are literals.

      戻り値:
        An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
        `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

        The values `self` and `all` are literals.

    - #### setExecutableUsers

          public void setExecutableUsers(java.util.Collection<java.lang.String> executableUsers)

      An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
      `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

      The values `self` and `all` are literals.

      パラメータ:
        `executableUsers` - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
        `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

        The values `self` and `all` are literals.

    - #### withExecutableUsers

          public DescribeImagesRequest withExecutableUsers(java.lang.String... executableUsers)

      An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
      `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

      The values `self` and `all` are literals.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `executableUsers` - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
        `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

        The values `self` and `all` are literals.

    - #### withExecutableUsers

          public DescribeImagesRequest withExecutableUsers(java.util.Collection<java.lang.String> executableUsers)

      An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
      `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

      The values `self` and `all` are literals.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `executableUsers` - An optional list of users whose launch permissions will be used to scope the described AMIs. Valid values are:
        `self` : AMIs for which you have explicit launch permissions `AWS account ID` : AMIs for which this account ID has launch permissions `all` : AMIs that have public launch permissions

        The values `self` and `all` are literals.

    - #### getFilters

          public java.util.List<Filter> getFilters()

      A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
      戻り値:
        A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    - #### setFilters

          public void setFilters(java.util.Collection<Filter> filters)

      A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.
      パラメータ:
        `filters` - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    - #### withFilters

          public DescribeImagesRequest withFilters(Filter... filters)

      A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `filters` - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    - #### withFilters

          public DescribeImagesRequest withFilters(java.util.Collection<Filter> filters)

      A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

      Returns a reference to this object so that method calls can be chained together.

      パラメータ:
        `filters` - A list of filters used to match properties for Images. For a complete reference to the available filter keys for this operation, see the Amazon EC2 API reference.

    - #### toString

          public java.lang.String toString()

      Returns a string representation of this object; useful for testing and debugging.
      オーバーライド:
        `toString` クラス内 `java.lang.Object`
      戻り値:
        A string representation of this object.
      関連項目:
        `Object.toString()`

    - #### hashCode

          public int hashCode()

      オーバーライド:
        `hashCode` クラス内 `java.lang.Object`

    - #### equals

          public boolean equals(java.lang.Object obj)

      オーバーライド:
        `equals` クラス内 `java.lang.Object`