DescribeSnapshotsRequest (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.ec2.model.DescribeSnapshotsRequest

All Implemented Interfaces:

DryRunSupportedRequest<DescribeSnapshotsRequest>, Serializable
```
public class DescribeSnapshotsRequest
extends AmazonWebServiceRequest
implements Serializable, DryRunSupportedRequest<DescribeSnapshotsRequest>
```
Container for the parameters to the DescribeSnapshots operation.
Describes one or more of the Amazon 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.

For more information about Amazon 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()

Constructors
Constructor and Description
`DescribeSnapshotsRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object obj)`
`Request<DescribeSnapshotsRequest>`	`getDryRunRequest()` This method is intended for internal use only.
`List<Filter>`	`getFilters()` One or more filters.
`List<String>`	`getOwnerIds()` Returns the snapshots owned by the specified owner.
`List<String>`	`getRestorableByUserIds()` One or more AWS accounts IDs that can create volumes from the snapshot.
`List<String>`	`getSnapshotIds()` One or more snapshot IDs.
`int`	`hashCode()`
`void`	`setFilters(Collection<Filter> filters)` One or more filters.
`void`	`setOwnerIds(Collection<String> ownerIds)` Returns the snapshots owned by the specified owner.
`void`	`setRestorableByUserIds(Collection<String> restorableByUserIds)` One or more AWS accounts IDs that can create volumes from the snapshot.
`void`	`setSnapshotIds(Collection<String> snapshotIds)` One or more snapshot IDs.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`DescribeSnapshotsRequest`	`withFilters(Collection<Filter> filters)` One or more filters.
`DescribeSnapshotsRequest`	`withFilters(Filter... filters)` One or more filters.
`DescribeSnapshotsRequest`	`withOwnerIds(Collection<String> ownerIds)` Returns the snapshots owned by the specified owner.
`DescribeSnapshotsRequest`	`withOwnerIds(String... ownerIds)` Returns the snapshots owned by the specified owner.
`DescribeSnapshotsRequest`	`withRestorableByUserIds(Collection<String> restorableByUserIds)` One or more AWS accounts IDs that can create volumes from the snapshot.
`DescribeSnapshotsRequest`	`withRestorableByUserIds(String... restorableByUserIds)` One or more AWS accounts IDs that can create volumes from the snapshot.
`DescribeSnapshotsRequest`	`withSnapshotIds(Collection<String> snapshotIds)` One or more snapshot IDs.
`DescribeSnapshotsRequest`	`withSnapshotIds(String... snapshotIds)` One or more snapshot IDs.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyPrivateRequestParameters, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setRequestCredentials, setRequestMetricCollector, withRequestMetricCollector

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeSnapshotsRequest
```
public DescribeSnapshotsRequest()
```
- Method Detail
  - getSnapshotIds
```
public List<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(Collection<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(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(Collection<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 List<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(Collection<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(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(Collection<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 List<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(Collection<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(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(Collection<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 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(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(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.
  - 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; 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

Did this page help you?

Class DescribeSnapshotsRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

DescribeSnapshotsRequest

Method Detail

getSnapshotIds

setSnapshotIds

withSnapshotIds

withSnapshotIds

getOwnerIds

setOwnerIds

withOwnerIds

withOwnerIds

getRestorableByUserIds

setRestorableByUserIds

withRestorableByUserIds

withRestorableByUserIds

getFilters

setFilters

withFilters

withFilters

getDryRunRequest

toString

hashCode

equals