Class DescribeInstanceStatusRequest
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeInstanceStatusRequest>
,Serializable
,Cloneable
Contains the parameters for DescribeInstanceStatus.
- See Also:
-
Field Summary
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionclone()
Creates a shallow clone of this request.boolean
This method is intended for internal use only.One or more filters.Whentrue
, includes the health status for all instances.One or more instance IDs.The maximum number of results to return in a single call.The token to retrieve the next page of results.int
hashCode()
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.toString()
Returns a string representation of this object; useful for testing and debugging.withFilters
(Filter... filters) One or more filters.withFilters
(Collection<Filter> filters) One or more filters.withIncludeAllInstances
(Boolean includeAllInstances) Whentrue
, includes the health status for all instances.withInstanceIds
(String... instanceIds) One or more instance IDs.withInstanceIds
(Collection<String> instanceIds) One or more instance IDs.withMaxResults
(Integer maxResults) The maximum number of results to return in a single call.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
-
Constructor Details
-
DescribeInstanceStatusRequest
public DescribeInstanceStatusRequest()
-
-
Method Details
-
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
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
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
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
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
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
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
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
The token to retrieve the next page of results.
- Parameters:
nextToken
- The token to retrieve the next page of results.
-
getNextToken
The token to retrieve the next page of results.
- Returns:
- The token to retrieve the next page of results.
-
withNextToken
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
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
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
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
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
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
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
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
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
Returns a string representation of this object; useful for testing and debugging. -
equals
-
hashCode
public int hashCode() -
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:
-