@Generated(value="software.amazon.awssdk:codegen") public final class DescribeSnapshotsRequest extends Ec2Request implements ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
Contains the parameters for DescribeSnapshots.
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeSnapshotsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeSnapshotsRequest.Builder |
builder() |
boolean |
equals(Object obj) |
List<Filter> |
filters()
One or more filters.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Integer |
maxResults()
The maximum number of snapshot results returned by
DescribeSnapshots in paginated output. |
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. |
List<String> |
ownerIds()
Returns the snapshots owned by the specified owner.
|
List<String> |
restorableByUserIds()
One or more AWS accounts IDs that can create volumes from the snapshot.
|
static Class<? extends DescribeSnapshotsRequest.Builder> |
serializableBuilderClass() |
List<String> |
snapshotIds()
One or more snapshot IDs.
|
DescribeSnapshotsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
overrideConfiguration
copy
public List<Filter> filters()
One or more filters.
description
- A description of the snapshot.
owner-alias
- Value from an Amazon-maintained list (amazon
|
aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the
user-configured AWS account alias, which is set from the IAM console.
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. Specify
the key of the tag in the filter name and the value of the tag in the filter value. For example, for the tag
Purpose=X, specify tag:Purpose
for the filter name and X
for the filter value.
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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
description
- A description of the snapshot.
owner-alias
- Value from an Amazon-maintained list (amazon
|
aws-marketplace
| microsoft
) of snapshot owners. Not to be confused with the
user-configured AWS account alias, which is set from the IAM console.
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.
Specify the key of the tag in the filter name and the value of the tag in the filter value. For example,
for the tag Purpose=X, specify tag:Purpose
for the filter name and X
for the
filter value.
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.
public 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.
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.public 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.
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.public List<String> ownerIds()
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> restorableByUserIds()
One or more AWS accounts IDs that can create volumes from the snapshot.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public List<String> snapshotIds()
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
Default: Describes snapshots for which you have launch permissions.
public DescribeSnapshotsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
toBuilder
in class Ec2Request
public static DescribeSnapshotsRequest.Builder builder()
public static Class<? extends DescribeSnapshotsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.