com.amazonaws.services.autoscaling.model

Class DescribeAutoScalingInstancesRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.autoscaling.model.DescribeAutoScalingInstancesRequest

All Implemented Interfaces:

Serializable

public class DescribeAutoScalingInstancesRequest
extends AmazonWebServiceRequest
implements Serializable

Container for the parameters to the DescribeAutoScalingInstances operation.

Returns a description of each Auto Scaling instance in the InstanceIds list. If a list is not provided, the service returns the full details of all instances up to a maximum of 50. By default, the service returns a list of 20 items.

This action supports pagination by returning a token if there are more pages to retrieve. To get the next page, call this action again with the returned token as the NextToken parameter.

See Also:

AmazonAutoScaling.describeAutoScalingInstances(DescribeAutoScalingInstancesRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeAutoScalingInstancesRequest()

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
List<String>	getInstanceIds() The list of Auto Scaling instances to describe.
Integer	getMaxRecords() The maximum number of Auto Scaling instances to be described with each call.
String	getNextToken() The token returned by a previous call to indicate that there is more data available.
int	hashCode()
void	setInstanceIds(Collection<String> instanceIds) The list of Auto Scaling instances to describe.
void	setMaxRecords(Integer maxRecords) The maximum number of Auto Scaling instances to be described with each call.
void	setNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeAutoScalingInstancesRequest	withInstanceIds(Collection<String> instanceIds) The list of Auto Scaling instances to describe.
DescribeAutoScalingInstancesRequest	withInstanceIds(String... instanceIds) The list of Auto Scaling instances to describe.
DescribeAutoScalingInstancesRequest	withMaxRecords(Integer maxRecords) The maximum number of Auto Scaling instances to be described with each call.
DescribeAutoScalingInstancesRequest	withNextToken(String nextToken) The token returned by a previous call to indicate that there is more data available.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeAutoScalingInstancesRequest

public DescribeAutoScalingInstancesRequest()

Method Detail

getInstanceIds

public List<String> getInstanceIds()

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

Returns:

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

setInstanceIds

public void setInstanceIds(Collection<String> instanceIds)

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

Parameters:

instanceIds - The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

withInstanceIds

public DescribeAutoScalingInstancesRequest withInstanceIds(String... instanceIds)

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

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

Parameters:

instanceIds - The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

Returns:

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

withInstanceIds

public DescribeAutoScalingInstancesRequest withInstanceIds(Collection<String> instanceIds)

The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

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

Parameters:

instanceIds - The list of Auto Scaling instances to describe. If this list is omitted, all auto scaling instances are described. The list of requested instances cannot contain more than 50 items. If unknown instances are requested, they are ignored with no error.

Returns:

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

getMaxRecords

public Integer getMaxRecords()

The maximum number of Auto Scaling instances to be described with each call.

Returns:

The maximum number of Auto Scaling instances to be described with each call.

setMaxRecords

public void setMaxRecords(Integer maxRecords)

The maximum number of Auto Scaling instances to be described with each call.

Parameters:

maxRecords - The maximum number of Auto Scaling instances to be described with each call.

withMaxRecords

public DescribeAutoScalingInstancesRequest withMaxRecords(Integer maxRecords)

The maximum number of Auto Scaling instances to be described with each call.

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

Parameters:

maxRecords - The maximum number of Auto Scaling instances to be described with each call.

Returns:

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

getNextToken

public String getNextToken()

The token returned by a previous call to indicate that there is more data available.

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Returns:

The token returned by a previous call to indicate that there is more data available.

setNextToken

public void setNextToken(String nextToken)

The token returned by a previous call to indicate that there is more data available.

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

nextToken - The token returned by a previous call to indicate that there is more data available.

withNextToken

public DescribeAutoScalingInstancesRequest withNextToken(String nextToken)

The token returned by a previous call to indicate that there is more data available.

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

Constraints:
Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Parameters:

nextToken - The token returned by a previous call to indicate that there is more data available.

Returns:

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

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