com.amazonaws.services.ec2.model

Class DescribeTagsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeTagsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeTagsRequest>, Serializable

public class DescribeTagsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeTagsRequest>

Container for the parameters to the DescribeTags operation.

Describes one or more of the tags for your EC2 resources.

For more information about tags, see Tagging Your Resources in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.describeTags(DescribeTagsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeTagsRequest() Default constructor for a new DescribeTagsRequest object.
DescribeTagsRequest(List<Filter> filters) Constructs a new DescribeTagsRequest object.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Request<DescribeTagsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() One or more filters.
Integer	getMaxResults() The maximum number of items to return for this call.
String	getNextToken() The token for the next set of items to return.
int	hashCode()
void	setFilters(Collection<Filter> filters) One or more filters.
void	setMaxResults(Integer maxResults) The maximum number of items to return for this call.
void	setNextToken(String nextToken) The token for the next set of items to return.
String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeTagsRequest	withFilters(Collection<Filter> filters) One or more filters.
DescribeTagsRequest	withFilters(Filter... filters) One or more filters.
DescribeTagsRequest	withMaxResults(Integer maxResults) The maximum number of items to return for this call.
DescribeTagsRequest	withNextToken(String nextToken) The token for the next set of items to return.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeTagsRequest

public DescribeTagsRequest()

Default constructor for a new DescribeTagsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize this object after creating it.

DescribeTagsRequest

public DescribeTagsRequest(List<Filter> filters)

Constructs a new DescribeTagsRequest object. Callers should use the setter or fluent setter (with...) methods to initialize any additional object members.

Parameters:

filters - One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

Method Detail

getFilters

public List<Filter> getFilters()

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

Returns:

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

setFilters

public void setFilters(Collection<Filter> filters)

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

Parameters:

filters - One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

withFilters

public DescribeTagsRequest withFilters(Filter... filters)

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

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

Parameters:

filters - One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

Returns:

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

withFilters

public DescribeTagsRequest withFilters(Collection<Filter> filters)

One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

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

Parameters:

filters - One or more filters.

• key - The tag key.

• resource-id - The resource ID.

• resource-type - The resource type (customer-gateway | dhcp-options | image | instance | internet-gateway | network-acl | network-interface | reserved-instances | route-table | security-group | snapshot | spot-instances-request | subnet | volume | vpc | vpn-connection | vpn-gateway).

• value - The tag value.

Returns:

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

getMaxResults

public Integer getMaxResults()

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Returns:

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

setMaxResults

public void setMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

withMaxResults

public DescribeTagsRequest withMaxResults(Integer maxResults)

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

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

Parameters:

maxResults - The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results. If the value is greater than 1000, we return only 1000 items.

Returns:

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

getNextToken

public String getNextToken()

The token for the next set of items to return. (You received this token from a prior call.)

Returns:

The token for the next set of items to return. (You received this token from a prior call.)

setNextToken

public void setNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a prior call.)

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a prior call.)

withNextToken

public DescribeTagsRequest withNextToken(String nextToken)

The token for the next set of items to return. (You received this token from a prior call.)

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

Parameters:

nextToken - The token for the next set of items to return. (You received this token from a prior call.)

Returns:

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

getDryRunRequest

public Request<DescribeTagsRequest> 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 interface DryRunSupportedRequest<DescribeTagsRequest>

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