com.amazonaws.services.ec2.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSnapshotsRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, DryRunSupportedRequest<DescribeSnapshotsRequest>, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSnapshotsRequest>

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
DescribeSnapshotsRequest	clone()
boolean	equals(Object obj)
Request<DescribeSnapshotsRequest>	getDryRunRequest() This method is intended for internal use only.
List<Filter>	getFilters() The filters.
Integer	getMaxResults() The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
String	getNextToken() The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter.
List<String>	getOwnerIds() Scopes the results to snapshots with the specified owners.
List<String>	getRestorableByUserIds() The IDs of the AWS accounts that can create volumes from the snapshot.
List<String>	getSnapshotIds() The snapshot IDs.
int	hashCode()
void	setFilters(Collection<Filter> filters) The filters.
void	setMaxResults(Integer maxResults) The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
void	setNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter.
void	setOwnerIds(Collection<String> ownerIds) Scopes the results to snapshots with the specified owners.
void	setRestorableByUserIds(Collection<String> restorableByUserIds) The IDs of the AWS accounts that can create volumes from the snapshot.
void	setSnapshotIds(Collection<String> snapshotIds) The snapshot IDs.
String	toString() Returns a string representation of this object.
DescribeSnapshotsRequest	withFilters(Collection<Filter> filters) The filters.
DescribeSnapshotsRequest	withFilters(Filter... filters) The filters.
DescribeSnapshotsRequest	withMaxResults(Integer maxResults) The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
DescribeSnapshotsRequest	withNextToken(String nextToken) The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter.
DescribeSnapshotsRequest	withOwnerIds(Collection<String> ownerIds) Scopes the results to snapshots with the specified owners.
DescribeSnapshotsRequest	withOwnerIds(String... ownerIds) Scopes the results to snapshots with the specified owners.
DescribeSnapshotsRequest	withRestorableByUserIds(Collection<String> restorableByUserIds) The IDs of the AWS accounts that can create volumes from the snapshot.
DescribeSnapshotsRequest	withRestorableByUserIds(String... restorableByUserIds) The IDs of the AWS accounts that can create volumes from the snapshot.
DescribeSnapshotsRequest	withSnapshotIds(Collection<String> snapshotIds) The snapshot IDs.
DescribeSnapshotsRequest	withSnapshotIds(String... snapshotIds) The snapshot IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getFilters

public List<Filter> getFilters()

The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

Returns:

The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

setFilters

public void setFilters(Collection<Filter> filters)

The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

Parameters:

filters - The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

withFilters

public DescribeSnapshotsRequest withFilters(Filter... filters)

The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

NOTE: This method appends the values to the existing list (if any). Use setFilters(java.util.Collection) or withFilters(java.util.Collection) if you want to override the existing values.

Parameters:

filters - The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

Returns:

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

withFilters

public DescribeSnapshotsRequest withFilters(Collection<Filter> filters)

The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

Parameters:

filters - The filters.

• description - A description of the snapshot.

• encrypted - Indicates whether the snapshot is encrypted (true | false)

• owner-alias - The owner alias, from an Amazon-maintained list (amazon). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter.

• owner-id - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter.

• progress - The progress of the snapshot, as a percentage (for example, 80%).

• snapshot-id - The snapshot ID.

• start-time - The time stamp when the snapshot was initiated.

• status - The status of the snapshot (pending | completed | error).

• tag:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key Owner and the value TeamA, specify tag:Owner for the filter name and TeamA for the filter value.

• tag-key - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value.

• volume-id - The ID of the volume the snapshot is for.

• volume-size - The size of the volume, in GiB.

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 snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Parameters:

maxResults - The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

getMaxResults

public Integer getMaxResults()

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Returns:

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

withMaxResults

public DescribeSnapshotsRequest withMaxResults(Integer maxResults)

The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Parameters:

maxResults - The maximum number of snapshot results returned by DescribeSnapshots in paginated output. When this parameter is used, DescribeSnapshots only returns MaxResults results in a single page along with a NextToken response element. The remaining results of the initial request can be seen by sending another DescribeSnapshots request with the returned NextToken value. This value can be between 5 and 1,000; if MaxResults is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then DescribeSnapshots returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request.

Returns:

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

setNextToken

public void setNextToken(String nextToken)

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

getNextToken

public String getNextToken()

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

withNextToken

public DescribeSnapshotsRequest withNextToken(String nextToken)

The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Parameters:

nextToken - The NextToken value returned from a previous paginated DescribeSnapshots request where MaxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the NextToken value. This value is null when there are no more results to return.

Returns:

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

getOwnerIds

public List<String> getOwnerIds()

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Returns:

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

setOwnerIds

public void setOwnerIds(Collection<String> ownerIds)

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Parameters:

ownerIds - Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(String... ownerIds)

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

NOTE: This method appends the values to the existing list (if any). Use setOwnerIds(java.util.Collection) or withOwnerIds(java.util.Collection) if you want to override the existing values.

Parameters:

ownerIds - Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Returns:

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

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(Collection<String> ownerIds)

Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Parameters:

ownerIds - Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, self, and amazon.

Returns:

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

getRestorableByUserIds

public List<String> getRestorableByUserIds()

The IDs of the AWS accounts that can create volumes from the snapshot.

Returns:

The IDs of the AWS accounts that can create volumes from the snapshot.

setRestorableByUserIds

public void setRestorableByUserIds(Collection<String> restorableByUserIds)

The IDs of the AWS accounts that can create volumes from the snapshot.

Parameters:

restorableByUserIds - The IDs of the AWS accounts that can create volumes from the snapshot.

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(String... restorableByUserIds)

The IDs of the AWS accounts that can create volumes from the snapshot.

NOTE: This method appends the values to the existing list (if any). Use setRestorableByUserIds(java.util.Collection) or withRestorableByUserIds(java.util.Collection) if you want to override the existing values.

Parameters:

restorableByUserIds - The IDs of the AWS accounts that can create volumes from the snapshot.

Returns:

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

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(Collection<String> restorableByUserIds)

The IDs of the AWS accounts that can create volumes from the snapshot.

Parameters:

restorableByUserIds - The IDs of the AWS accounts that can create volumes from the snapshot.

Returns:

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

getSnapshotIds

public List<String> getSnapshotIds()

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Returns:

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

setSnapshotIds

public void setSnapshotIds(Collection<String> snapshotIds)

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Parameters:

snapshotIds - The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds)

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

NOTE: This method appends the values to the existing list (if any). Use setSnapshotIds(java.util.Collection) or withSnapshotIds(java.util.Collection) if you want to override the existing values.

Parameters:

snapshotIds - The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Returns:

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

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(Collection<String> snapshotIds)

The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Parameters:

snapshotIds - The snapshot IDs.

Default: Describes the snapshots for which you have create volume permissions.

Returns:

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

getDryRunRequest

public Request<DescribeSnapshotsRequest> 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<DescribeSnapshotsRequest>

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public DescribeSnapshotsRequest clone()

Overrides:

clone in class AmazonWebServiceRequest