com.amazonaws.services.ec2.model
Class DescribeInstanceStatusRequest

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

public class DescribeInstanceStatusRequest
extends AmazonWebServiceRequest

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.

See Also:

AmazonEC2.describeInstanceStatus(DescribeInstanceStatusRequest)

Constructor Summary

DescribeInstanceStatusRequest()

Method Summary

boolean	equals(Object obj)
List<Filter>	getFilters() The list of filters to limit returned results.
Boolean	getIncludeAllInstances() Returns the value of the IncludeAllInstances property for this object.
List<String>	getInstanceIds() The list of instance IDs.
Integer	getMaxResults() The maximum number of paginated instance items per response.
String	getNextToken() A string specifying the next paginated set of results to return.
int	hashCode()
Boolean	isIncludeAllInstances() Returns the value of the IncludeAllInstances property for this object.
void	setFilters(Collection<Filter> filters) The list of filters to limit returned results.
void	setIncludeAllInstances(Boolean includeAllInstances) Sets the value of the IncludeAllInstances property for this object.
void	setInstanceIds(Collection<String> instanceIds) The list of instance IDs.
void	setMaxResults(Integer maxResults) The maximum number of paginated instance items per response.
void	setNextToken(String nextToken) A string specifying the next paginated set of results to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeInstanceStatusRequest	withFilters(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(Boolean includeAllInstances) Sets the value of the IncludeAllInstances property for this object.
DescribeInstanceStatusRequest	withInstanceIds(Collection<String> instanceIds) The list of instance IDs.
DescribeInstanceStatusRequest	withInstanceIds(String... instanceIds) The list of instance IDs.
DescribeInstanceStatusRequest	withMaxResults(Integer maxResults) The maximum number of paginated instance items per response.
DescribeInstanceStatusRequest	withNextToken(String nextToken) A string specifying the next paginated set of results to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getDelegationToken, getRequestClientOptions, getRequestCredentials, setDelegationToken, setRequestCredentials

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeInstanceStatusRequest

public DescribeInstanceStatusRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

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

Returns:

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

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

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

Parameters:

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

withInstanceIds

public DescribeInstanceStatusRequest withInstanceIds(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.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

withInstanceIds

public DescribeInstanceStatusRequest withInstanceIds(Collection<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.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getFilters

public List<Filter> getFilters()

The list of filters to limit returned results.

Returns:

The list of filters to limit returned results.

setFilters

public void setFilters(Collection<Filter> filters)

The list of filters to limit returned results.

Parameters:

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.

Parameters:

filters - The list of filters to limit returned results.

Returns:

A reference to this updated object so that method calls can be chained together.

withFilters

public DescribeInstanceStatusRequest withFilters(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.

Parameters:

filters - The list of filters to limit returned results.

Returns:

A reference to this updated object so that method calls can be chained together.

getNextToken

public String getNextToken()

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

Returns:

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

setNextToken

public void setNextToken(String nextToken)

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

Parameters:

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

withNextToken

public DescribeInstanceStatusRequest withNextToken(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.

Parameters:

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

Returns:

A reference to this updated object so that method calls can be chained together.

getMaxResults

public Integer getMaxResults()

The maximum number of paginated instance items per response.

Returns:

The maximum number of paginated instance items per response.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of paginated instance items per response.

Parameters:

maxResults - The maximum number of paginated instance items per response.

withMaxResults

public DescribeInstanceStatusRequest withMaxResults(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.

Parameters:

maxResults - The maximum number of paginated instance items per response.

Returns:

A reference to this updated object so that method calls can be chained together.

isIncludeAllInstances

public Boolean isIncludeAllInstances()

Returns the value of the IncludeAllInstances property for this object.

Returns:

The value of the IncludeAllInstances property for this object.

setIncludeAllInstances

public void setIncludeAllInstances(Boolean includeAllInstances)

Sets the value of the IncludeAllInstances property for this object.

Parameters:

includeAllInstances - The new value for the IncludeAllInstances property for this object.

withIncludeAllInstances

public DescribeInstanceStatusRequest withIncludeAllInstances(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.

Parameters:

includeAllInstances - The new value for the IncludeAllInstances property for this object.

Returns:

A reference to this updated object so that method calls can be chained together.

getIncludeAllInstances

public Boolean getIncludeAllInstances()

Returns the value of the IncludeAllInstances property for this object.

Returns:

The value of the IncludeAllInstances property for this object.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object