com.amazonaws.services.ec2.model

## クラス DescribeInstanceStatusRequest

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

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

      public class DescribeInstanceStatusRequest
      extends AmazonWebServiceRequest
      implements java.io.Serializable

  Container for the parameters to the `DescribeInstanceStatus operation`.

  Describes the status of an Amazon Elastic Compute Cloud (Amazon EC2) instance. Instance status provides information about two types of scheduled events for an instance that may require your attention:

  - Scheduled Reboot: When Amazon EC2 determines that an instance must be rebooted, the instance's status will return one of two event codes: `system-reboot` or `instance-reboot` . System reboot commonly occurs if certain maintenance or upgrade operations require a reboot of the underlying host that supports an instance. Instance reboot commonly occurs if the instance must be rebooted, rather than the underlying host. Rebooting events include a scheduled start and end time.
  - Scheduled Retirement: When Amazon EC2 determines that an instance must be shut down, the instance's status will return an event code called `instance-retirement` . Retirement commonly occurs when the underlying host is degraded and must be replaced. Retirement events include a scheduled start and end time. You're also notified by email if one of your instances is set to retiring. The email message indicates when your instance will be permanently retired.

  If your instance is permanently retired, it will not be restarted. You can avoid retirement by manually restarting your instance when its event code is `instance-retirement` . This ensures that your instance is started on a healthy host.

  `DescribeInstanceStatus` returns information only for instances in the running state.

  You can filter the results to return information only about instances that match criteria you specify. For example, you could get information about instances in a specific Availability Zone. You can specify multiple values for a filter (e.g., more than one Availability Zone). An instance must match at least one of the specified values for it to be included in the results.

  You can specify multiple filters. An instance must match all the filters for it to be included in the results. If there's no match, no special message is returned; the response is simply empty.

  You can use wildcards with the filter values: `*` matches zero or more characters, and `?` matches exactly one character. You can escape special characters using a backslash before the character. For example, a value of `\*amazon\?\\` searches for the literal string `*amazon?\` .

  The following filters are available:

  - `availability-zone` - Filter on an instance's availability zone.
  - `instance-state-name` - Filter on the intended state of the instance, e.g., running.
  - `instance-state-code` - Filter on the intended state code of the instance, e.g., 16.
  関連項目:
    `AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest)`, 直列化された形式

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

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

  - ### メソッドの概要

    メソッド
    修飾子とタイプ | メソッドと説明
    --- | ---
    `boolean` | `equals(java.lang.Object obj)`
    `java.util.List<Filter>` | `getFilters()` The list of filters to limit returned results.
    `java.lang.Boolean` | `getIncludeAllInstances()` Returns the value of the IncludeAllInstances property for this object.
    `java.util.List<java.lang.String>` | `getInstanceIds()` The list of instance IDs.
    `java.lang.Integer` | `getMaxResults()` The maximum number of paginated instance items per response.
    `java.lang.String` | `getNextToken()` A string specifying the next paginated set of results to return.
    `int` | `hashCode()`
    `java.lang.Boolean` | `isIncludeAllInstances()` Returns the value of the IncludeAllInstances property for this object.
    `void` | `setFilters(java.util.Collection<Filter> filters)` The list of filters to limit returned results.
    `void` | `setIncludeAllInstances(java.lang.Boolean includeAllInstances)` Sets the value of the IncludeAllInstances property for this object.
    `void` | `setInstanceIds(java.util.Collection<java.lang.String> instanceIds)` The list of instance IDs.
    `void` | `setMaxResults(java.lang.Integer maxResults)` The maximum number of paginated instance items per response.
    `void` | `setNextToken(java.lang.String nextToken)` A string specifying the next paginated set of results to return.
    `java.lang.String` | `toString()` Returns a string representation of this object; useful for testing and debugging.
    `DescribeInstanceStatusRequest` | `withFilters(java.util.Collection<Filter> filters)` The list of filters to limit returned results.
    `DescribeInstanceStatusRequest` | `withFilters(Filter... filters)` The list of filters to limit returned results.
    `DescribeInstanceStatusRequest` | `withIncludeAllInstances(java.lang.Boolean includeAllInstances)` Sets the value of the IncludeAllInstances property for this object.
    `DescribeInstanceStatusRequest` | `withInstanceIds(java.util.Collection<java.lang.String> instanceIds)` The list of instance IDs.
    `DescribeInstanceStatusRequest` | `withInstanceIds(java.lang.String... instanceIds)` The list of instance IDs.
    `DescribeInstanceStatusRequest` | `withMaxResults(java.lang.Integer maxResults)` The maximum number of paginated instance items per response.
    `DescribeInstanceStatusRequest` | `withNextToken(java.lang.String nextToken)` A string specifying the next paginated set of results to return.

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

      `copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, setRequestCredentials`

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

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

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

    - #### DescribeInstanceStatusRequest

          public DescribeInstanceStatusRequest()

  - ### メソッドの詳細

    - #### getInstanceIds

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

      The list of instance IDs. If not specified, all instances are described.
      戻り値:
        The list of instance IDs. If not specified, all instances are described.

    - #### setInstanceIds

          public void setInstanceIds(java.util.Collection<java.lang.String> instanceIds)

      The list of instance IDs. If not specified, all instances are described.
      パラメータ:
        `instanceIds` - The list of instance IDs. If not specified, all instances are described.

    - #### withInstanceIds

          public DescribeInstanceStatusRequest withInstanceIds(java.lang.String... instanceIds)

      The list of instance IDs. If not specified, all instances are described.

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

      パラメータ:
        `instanceIds` - The list of instance IDs. If not specified, all instances are described.

    - #### withInstanceIds

          public DescribeInstanceStatusRequest withInstanceIds(java.util.Collection<java.lang.String> instanceIds)

      The list of instance IDs. If not specified, all instances are described.

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

      パラメータ:
        `instanceIds` - The list of instance IDs. If not specified, all instances are described.

    - #### getFilters

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

      The list of filters to limit returned results.
      戻り値:
        The list of filters to limit returned results.

    - #### setFilters

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

      The list of filters to limit returned results.
      パラメータ:
        `filters` - The list of filters to limit returned results.

    - #### withFilters

          public DescribeInstanceStatusRequest withFilters(Filter... filters)

      The list of filters to limit returned results.

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

      パラメータ:
        `filters` - The list of filters to limit returned results.

    - #### withFilters

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

      The list of filters to limit returned results.

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

      パラメータ:
        `filters` - The list of filters to limit returned results.

    - #### getNextToken

          public java.lang.String getNextToken()

      A string specifying the next paginated set of results to return.
      戻り値:
        A string specifying the next paginated set of results to return.

    - #### setNextToken

          public void setNextToken(java.lang.String nextToken)

      A string specifying the next paginated set of results to return.
      パラメータ:
        `nextToken` - A string specifying the next paginated set of results to return.

    - #### withNextToken

          public DescribeInstanceStatusRequest withNextToken(java.lang.String nextToken)

      A string specifying the next paginated set of results to return.

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

      パラメータ:
        `nextToken` - A string specifying the next paginated set of results to return.

    - #### getMaxResults

          public java.lang.Integer getMaxResults()

      The maximum number of paginated instance items per response.
      戻り値:
        The maximum number of paginated instance items per response.

    - #### setMaxResults

          public void setMaxResults(java.lang.Integer maxResults)

      The maximum number of paginated instance items per response.
      パラメータ:
        `maxResults` - The maximum number of paginated instance items per response.

    - #### withMaxResults

          public DescribeInstanceStatusRequest withMaxResults(java.lang.Integer maxResults)

      The maximum number of paginated instance items per response.

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

      パラメータ:
        `maxResults` - The maximum number of paginated instance items per response.

    - #### isIncludeAllInstances

          public java.lang.Boolean isIncludeAllInstances()

      Returns the value of the IncludeAllInstances property for this object.
      戻り値:
        The value of the IncludeAllInstances property for this object.

    - #### setIncludeAllInstances

          public void setIncludeAllInstances(java.lang.Boolean includeAllInstances)

      Sets the value of the IncludeAllInstances property for this object.
      パラメータ:
        `includeAllInstances` - The new value for the IncludeAllInstances property for this object.

    - #### withIncludeAllInstances

          public DescribeInstanceStatusRequest withIncludeAllInstances(java.lang.Boolean includeAllInstances)

      Sets the value of the IncludeAllInstances property for this object.

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

      パラメータ:
        `includeAllInstances` - The new value for the IncludeAllInstances property for this object.

    - #### getIncludeAllInstances

          public java.lang.Boolean getIncludeAllInstances()

      Returns the value of the IncludeAllInstances property for this object.
      戻り値:
        The value of the IncludeAllInstances property for this object.

    - #### 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`