Class DescribeInstanceStatusRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeInstanceStatusRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeInstanceStatusRequest>
,Serializable
,Cloneable
public class DescribeInstanceStatusRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeInstanceStatusRequest>
Contains the parameters for DescribeInstanceStatus.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeInstanceStatusRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeInstanceStatusRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
Request<DescribeInstanceStatusRequest>
getDryRunRequest()
This method is intended for internal use only.List<Filter>
getFilters()
One or more filters.Boolean
getIncludeAllInstances()
Whentrue
, includes the health status for all instances.List<String>
getInstanceIds()
One or more instance IDs.Integer
getMaxResults()
The maximum number of results to return in a single call.String
getNextToken()
The token to retrieve the next page of results.int
hashCode()
Boolean
isIncludeAllInstances()
Whentrue
, includes the health status for all instances.void
setFilters(Collection<Filter> filters)
One or more filters.void
setIncludeAllInstances(Boolean includeAllInstances)
Whentrue
, includes the health status for all instances.void
setInstanceIds(Collection<String> instanceIds)
One or more instance IDs.void
setMaxResults(Integer maxResults)
The maximum number of results to return in a single call.void
setNextToken(String nextToken)
The token to retrieve the next page of results.String
toString()
Returns a string representation of this object; useful for testing and debugging.DescribeInstanceStatusRequest
withFilters(Filter... filters)
One or more filters.DescribeInstanceStatusRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeInstanceStatusRequest
withIncludeAllInstances(Boolean includeAllInstances)
Whentrue
, includes the health status for all instances.DescribeInstanceStatusRequest
withInstanceIds(String... instanceIds)
One or more instance IDs.DescribeInstanceStatusRequest
withInstanceIds(Collection<String> instanceIds)
One or more instance IDs.DescribeInstanceStatusRequest
withMaxResults(Integer maxResults)
The maximum number of results to return in a single call.DescribeInstanceStatusRequest
withNextToken(String nextToken)
The token to retrieve the next page of results.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
getInstanceIds
public List<String> getInstanceIds()
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- Returns:
- One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
-
setInstanceIds
public void setInstanceIds(Collection<String> instanceIds)
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- Parameters:
instanceIds
- One or more instance IDs.Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
-
withInstanceIds
public DescribeInstanceStatusRequest withInstanceIds(String... instanceIds)
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
NOTE: This method appends the values to the existing list (if any). Use
setInstanceIds(java.util.Collection)
orwithInstanceIds(java.util.Collection)
if you want to override the existing values.- Parameters:
instanceIds
- One or more instance IDs.Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
withInstanceIds
public DescribeInstanceStatusRequest withInstanceIds(Collection<String> instanceIds)
One or more instance IDs.
Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- Parameters:
instanceIds
- One or more instance IDs.Default: Describes all your instances.
Constraints: Maximum 100 explicitly specified instance IDs.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
getFilters
public List<Filter> getFilters()
One or more filters.
-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
- Returns:
- One or more filters.
-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
-
-
-
setFilters
public void setFilters(Collection<Filter> filters)
One or more filters.
-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
- Parameters:
filters
- One or more filters.-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
-
-
-
withFilters
public DescribeInstanceStatusRequest withFilters(Filter... filters)
One or more filters.
-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
NOTE: This method appends the values to the existing list (if any). Use
setFilters(java.util.Collection)
orwithFilters(java.util.Collection)
if you want to override the existing values.- Parameters:
filters
- One or more filters.-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
withFilters
public DescribeInstanceStatusRequest withFilters(Collection<Filter> filters)
One or more filters.
-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
- Parameters:
filters
- One or more filters.-
availability-zone
- The Availability Zone of the instance. -
event.code
- The code for the scheduled event (instance-reboot
|system-reboot
|system-maintenance
|instance-retirement
|instance-stop
). -
event.description
- A description of the event. -
event.not-after
- The latest end time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
event.not-before
- The earliest start time for the scheduled event (for example,2014-09-15T17:15:20.000Z
). -
instance-state-code
- The code for the instance state, as a 16-bit unsigned integer. The high byte is an opaque internal value and should be ignored. The low byte is set based on the state represented. The valid values are 0 (pending), 16 (running), 32 (shutting-down), 48 (terminated), 64 (stopping), and 80 (stopped). -
instance-state-name
- The state of the instance (pending
|running
|shutting-down
|terminated
|stopping
|stopped
). -
instance-status.reachability
- Filters on instance status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
instance-status.status
- The status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
). -
system-status.reachability
- Filters on system status where the name isreachability
(passed
|failed
|initializing
|insufficient-data
). -
system-status.status
- The system status of the instance (ok
|impaired
|initializing
|insufficient-data
|not-applicable
).
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
setNextToken
public void setNextToken(String nextToken)
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.
-
getNextToken
public String getNextToken()
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
withNextToken
public DescribeInstanceStatusRequest withNextToken(String nextToken)
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setMaxResults
public void setMaxResults(Integer maxResults)
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.- Parameters:
maxResults
- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
-
getMaxResults
public Integer getMaxResults()
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.- Returns:
- The maximum number of results to return in a single call. To
retrieve the remaining results, make another call with the
returned
NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.
-
withMaxResults
public DescribeInstanceStatusRequest withMaxResults(Integer maxResults)
The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned
NextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.- Parameters:
maxResults
- The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returnedNextToken
value. This value can be between 5 and 1000. You cannot specify this parameter and the instance IDs parameter in the same call.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
setIncludeAllInstances
public void setIncludeAllInstances(Boolean includeAllInstances)
When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Parameters:
includeAllInstances
- Whentrue
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
-
getIncludeAllInstances
public Boolean getIncludeAllInstances()
When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Returns:
- When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
-
withIncludeAllInstances
public DescribeInstanceStatusRequest withIncludeAllInstances(Boolean includeAllInstances)
When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Parameters:
includeAllInstances
- Whentrue
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
isIncludeAllInstances
public Boolean isIncludeAllInstances()
When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
- Returns:
- When
true
, includes the health status for all instances. Whenfalse
, includes the health status for running instances only.Default:
false
-
getDryRunRequest
public Request<DescribeInstanceStatusRequest> getDryRunRequest()
This method is intended for internal use only. Returns the marshaled request configured with additional parameters to enable operation dry-run.- Specified by:
getDryRunRequest
in interfaceDryRunSupportedRequest<DescribeInstanceStatusRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeInstanceStatusRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-