com.amazonaws.services.ec2.model

Class DescribeSnapshotsRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.ec2.model.DescribeSnapshotsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSnapshotsRequest>, java.io.Serializable, java.lang.Cloneable

public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements java.io.Serializable, DryRunSupportedRequest<DescribeSnapshotsRequest>

Container for the parameters to the DescribeSnapshots operation.

Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.

The create volume permissions fall into the following categories:

• public : The owner of the snapshot granted create volume permissions for the snapshot to the all group. All AWS accounts have create volume permissions for these snapshots.

• explicit : The owner of the snapshot granted create volume permissions to a specific AWS account.

• implicit : An AWS account has implicit create volume permissions for all snapshots it owns.

The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.

If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.

If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. The results can include the AWS account IDs of the specified owners, amazon for snapshots owned by Amazon, or self for snapshots that you own.

If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. You can specify AWS account IDs (if you own the snapshots), self for snapshots for which you own or have explicit permissions, or all for public snapshots.

If you are describing a long list of snapshots, you can paginate the output to make the list more manageable. The MaxResults parameter sets the maximum number of results returned in a single page. If the list of results exceeds your MaxResults value, then that number of results is returned along with a NextToken value that can be passed to a subsequent DescribeSnapshots request to retrieve the remaining results.

For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide .

See Also:

AmazonEC2.describeSnapshots(DescribeSnapshotsRequest), Serialized Form

Constructor Summary

Constructors

Constructor and Description
DescribeSnapshotsRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object obj)
Request<DescribeSnapshotsRequest>	getDryRunRequest() This method is intended for internal use only.
java.util.List<Filter>	getFilters() One or more filters.
java.lang.Integer	getMaxResults() The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
java.lang.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.
java.util.List<java.lang.String>	getOwnerIds() Returns the snapshots owned by the specified owner.
java.util.List<java.lang.String>	getRestorableByUserIds() One or more AWS accounts IDs that can create volumes from the snapshot.
java.util.List<java.lang.String>	getSnapshotIds() One or more snapshot IDs.
int	hashCode()
void	setFilters(java.util.Collection<Filter> filters) One or more filters.
void	setMaxResults(java.lang.Integer maxResults) The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
void	setNextToken(java.lang.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(java.util.Collection<java.lang.String> ownerIds) Returns the snapshots owned by the specified owner.
void	setRestorableByUserIds(java.util.Collection<java.lang.String> restorableByUserIds) One or more AWS accounts IDs that can create volumes from the snapshot.
void	setSnapshotIds(java.util.Collection<java.lang.String> snapshotIds) One or more snapshot IDs.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
DescribeSnapshotsRequest	withFilters(java.util.Collection<Filter> filters) One or more filters.
DescribeSnapshotsRequest	withFilters(Filter... filters) One or more filters.
DescribeSnapshotsRequest	withMaxResults(java.lang.Integer maxResults) The maximum number of snapshot results returned by DescribeSnapshots in paginated output.
DescribeSnapshotsRequest	withNextToken(java.lang.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(java.util.Collection<java.lang.String> ownerIds) Returns the snapshots owned by the specified owner.
DescribeSnapshotsRequest	withOwnerIds(java.lang.String... ownerIds) Returns the snapshots owned by the specified owner.
DescribeSnapshotsRequest	withRestorableByUserIds(java.util.Collection<java.lang.String> restorableByUserIds) One or more AWS accounts IDs that can create volumes from the snapshot.
DescribeSnapshotsRequest	withRestorableByUserIds(java.lang.String... restorableByUserIds) One or more AWS accounts IDs that can create volumes from the snapshot.
DescribeSnapshotsRequest	withSnapshotIds(java.util.Collection<java.lang.String> snapshotIds) One or more snapshot IDs.
DescribeSnapshotsRequest	withSnapshotIds(java.lang.String... snapshotIds) One or more snapshot IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DescribeSnapshotsRequest

public DescribeSnapshotsRequest()

Method Detail

getSnapshotIds

public java.util.List<java.lang.String> getSnapshotIds()

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Returns:

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

setSnapshotIds

public void setSnapshotIds(java.util.Collection<java.lang.String> snapshotIds)

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Parameters:

snapshotIds - One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(java.lang.String... snapshotIds)

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

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

Parameters:

snapshotIds - One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Returns:

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

withSnapshotIds

public DescribeSnapshotsRequest withSnapshotIds(java.util.Collection<java.lang.String> snapshotIds)

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

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

Parameters:

snapshotIds - One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.

Returns:

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

getOwnerIds

public java.util.List<java.lang.String> getOwnerIds()

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

Returns:

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

setOwnerIds

public void setOwnerIds(java.util.Collection<java.lang.String> ownerIds)

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

Parameters:

ownerIds - Returns the snapshots owned by the specified owner. Multiple owners can be specified.

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(java.lang.String... ownerIds)

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

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

Parameters:

ownerIds - Returns the snapshots owned by the specified owner. Multiple owners can be specified.

Returns:

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

withOwnerIds

public DescribeSnapshotsRequest withOwnerIds(java.util.Collection<java.lang.String> ownerIds)

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

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

Parameters:

ownerIds - Returns the snapshots owned by the specified owner. Multiple owners can be specified.

Returns:

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

getRestorableByUserIds

public java.util.List<java.lang.String> getRestorableByUserIds()

One or more AWS accounts IDs that can create volumes from the snapshot.

Returns:

One or more AWS accounts IDs that can create volumes from the snapshot.

setRestorableByUserIds

public void setRestorableByUserIds(java.util.Collection<java.lang.String> restorableByUserIds)

One or more AWS accounts IDs that can create volumes from the snapshot.

Parameters:

restorableByUserIds - One or more AWS accounts IDs that can create volumes from the snapshot.

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(java.lang.String... restorableByUserIds)

One or more AWS accounts IDs that can create volumes from the snapshot.

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

Parameters:

restorableByUserIds - One or more AWS accounts IDs that can create volumes from the snapshot.

Returns:

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

withRestorableByUserIds

public DescribeSnapshotsRequest withRestorableByUserIds(java.util.Collection<java.lang.String> restorableByUserIds)

One or more AWS accounts IDs that can create volumes from the snapshot.

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

Parameters:

restorableByUserIds - One or more AWS accounts IDs that can create volumes from the snapshot.

Returns:

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

getFilters

public java.util.List<Filter> getFilters()

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

Returns:

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

setFilters

public void setFilters(java.util.Collection<Filter> filters)

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

Parameters:

filters - One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

• 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)

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

Parameters:

filters - One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

Returns:

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

withFilters

public DescribeSnapshotsRequest withFilters(java.util.Collection<Filter> filters)

One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

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

Parameters:

filters - One or more filters.

• description - A description of the snapshot.

• owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.

• owner-id - The ID of the AWS account that owns the snapshot.

• 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=value - The key/value combination of a tag assigned to the resource.

• tag-key - The key of a tag assigned to the resource. This filter is independent of the tag-value filter. For example, if you use both the filter "tag-key=Purpose" and the filter "tag-value=X", you get any resources assigned both the tag key Purpose (regardless of what the tag's value is), and the tag value X (regardless of what the tag's key is). If you want to list only resources where Purpose is X, see the tag:key=value filter.

• tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.

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

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

Returns:

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

getNextToken

public java.lang.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.

setNextToken

public void setNextToken(java.lang.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.

withNextToken

public DescribeSnapshotsRequest withNextToken(java.lang.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.

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

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:

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

getMaxResults

public java.lang.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 1000; if MaxResults is given a value larger than 1000, only 1000 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 1000; if MaxResults is given a value larger than 1000, only 1000 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.

setMaxResults

public void setMaxResults(java.lang.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 1000; if MaxResults is given a value larger than 1000, only 1000 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 1000; if MaxResults is given a value larger than 1000, only 1000 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(java.lang.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 1000; if MaxResults is given a value larger than 1000, only 1000 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 a reference to this object so that method calls can be chained together.

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 1000; if MaxResults is given a value larger than 1000, only 1000 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:

A reference to this updated 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 java.lang.String toString()

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

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object