@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSnapshotsRequest>
Contains the parameters for DescribeSnapshots.
NOOP
Constructor and Description |
---|
DescribeSnapshotsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeSnapshotsRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Request<DescribeSnapshotsRequest> |
getDryRunRequest()
This method is intended for internal use only.
|
List<Filter> |
getFilters()
One or more 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()
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 |
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)
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 |
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)
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.
|
addHandlerContext, 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
public List<Filter> getFilters()
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.
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 void setFilters(Collection<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.
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.
public DescribeSnapshotsRequest withFilters(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.
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.
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.
public DescribeSnapshotsRequest withFilters(Collection<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.
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.
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 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.
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.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 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 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 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.
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.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.
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.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.
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 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.
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.public List<String> getOwnerIds()
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
public void setOwnerIds(Collection<String> ownerIds)
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
ownerIds
- Returns the snapshots owned by the specified owner. Multiple owners can be specified.public DescribeSnapshotsRequest withOwnerIds(String... ownerIds)
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
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.
ownerIds
- Returns the snapshots owned by the specified owner. Multiple owners can be specified.public DescribeSnapshotsRequest withOwnerIds(Collection<String> ownerIds)
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
ownerIds
- Returns the snapshots owned by the specified owner. Multiple owners can be specified.public List<String> getRestorableByUserIds()
One or more AWS accounts IDs that can create volumes from the snapshot.
public void setRestorableByUserIds(Collection<String> restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.
restorableByUserIds
- One or more AWS accounts IDs that can create volumes from the snapshot.public DescribeSnapshotsRequest withRestorableByUserIds(String... restorableByUserIds)
One or more AWS accounts IDs 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.
restorableByUserIds
- One or more AWS accounts IDs that can create volumes from the snapshot.public DescribeSnapshotsRequest withRestorableByUserIds(Collection<String> restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.
restorableByUserIds
- One or more AWS accounts IDs that can create volumes from the snapshot.public List<String> getSnapshotIds()
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
Default: Describes snapshots for which you have launch permissions.
public void setSnapshotIds(Collection<String> snapshotIds)
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
snapshotIds
- One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds)
One or more snapshot IDs.
Default: Describes snapshots for which you have launch 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.
snapshotIds
- One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
public DescribeSnapshotsRequest withSnapshotIds(Collection<String> snapshotIds)
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
snapshotIds
- One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
public Request<DescribeSnapshotsRequest> getDryRunRequest()
getDryRunRequest
in interface DryRunSupportedRequest<DescribeSnapshotsRequest>
public String toString()
toString
in class Object
Object.toString()
public DescribeSnapshotsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.