Class DescribeSnapshotsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.ec2.model.DescribeSnapshotsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,DryRunSupportedRequest<DescribeSnapshotsRequest>
,Serializable
,Cloneable
public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable, DryRunSupportedRequest<DescribeSnapshotsRequest>
Contains the parameters for DescribeSnapshots.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description DescribeSnapshotsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DescribeSnapshotsRequest
clone()
Creates a shallow clone of this request.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 byDescribeSnapshots
in paginated output.String
getNextToken()
TheNextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
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 byDescribeSnapshots
in paginated output.void
setNextToken(String nextToken)
TheNextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
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(Filter... filters)
One or more filters.DescribeSnapshotsRequest
withFilters(Collection<Filter> filters)
One or more filters.DescribeSnapshotsRequest
withMaxResults(Integer maxResults)
The maximum number of snapshot results returned byDescribeSnapshots
in paginated output.DescribeSnapshotsRequest
withNextToken(String nextToken)
TheNextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter.DescribeSnapshotsRequest
withOwnerIds(String... ownerIds)
Returns the snapshots owned by the specified owner.DescribeSnapshotsRequest
withOwnerIds(Collection<String> ownerIds)
Returns the snapshots owned by the specified owner.DescribeSnapshotsRequest
withRestorableByUserIds(String... restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.DescribeSnapshotsRequest
withRestorableByUserIds(Collection<String> restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.DescribeSnapshotsRequest
withSnapshotIds(String... snapshotIds)
One or more snapshot IDs.DescribeSnapshotsRequest
withSnapshotIds(Collection<String> snapshotIds)
One or more snapshot IDs.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
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.
NOTE: This method appends the values to the existing list (if any). Use
setSnapshotIds(java.util.Collection)
orwithSnapshotIds(java.util.Collection)
if you want to override the existing values.- Parameters:
snapshotIds
- One or more snapshot IDs.Default: Describes snapshots for which you have launch permissions.
- Returns:
- Returns a reference to this 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.
- Parameters:
snapshotIds
- One or more snapshot IDs.Default: Describes snapshots for which you have launch permissions.
- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setOwnerIds(java.util.Collection)
orwithOwnerIds(java.util.Collection)
if you want to override the existing values.- Parameters:
ownerIds
- Returns the snapshots owned by the specified owner. Multiple owners can be specified.- Returns:
- Returns a reference to this 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.
- Parameters:
ownerIds
- Returns the snapshots owned by the specified owner. Multiple owners can be specified.- Returns:
- Returns a reference to this 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.
NOTE: This method appends the values to the existing list (if any). Use
setRestorableByUserIds(java.util.Collection)
orwithRestorableByUserIds(java.util.Collection)
if you want to override the existing values.- Parameters:
restorableByUserIds
- One or more AWS accounts IDs 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)
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.- Returns:
- Returns a reference to this 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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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)
orwithFilters(java.util.Collection)
if you want to override the existing values.- 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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
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)
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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-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 thetag-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 thetag
:key=value filter. -
tag-value
- The value of a tag assigned to the resource. This filter is independent of thetag-key
filter. -
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.
-
-
setNextToken
public void setNextToken(String nextToken)
The
NextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
getNextToken
public String getNextToken()
The
NextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Returns:
- The
NextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.
-
withNextToken
public DescribeSnapshotsRequest withNextToken(String nextToken)
The
NextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- Parameters:
nextToken
- TheNextToken
value returned from a previous paginatedDescribeSnapshots
request whereMaxResults
was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned theNextToken
value. This value isnull
when there are no more results to return.- 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 returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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 byDescribeSnapshots
in paginated output. When this parameter is used,DescribeSnapshots
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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 returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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 returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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 returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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 byDescribeSnapshots
in paginated output. When this parameter is used,DescribeSnapshots
only returnsMaxResults
results in a single page along with aNextToken
response element. The remaining results of the initial request can be seen by sending anotherDescribeSnapshots
request with the returnedNextToken
value. This value can be between 5 and 1000; ifMaxResults
is given a value larger than 1000, only 1000 results are returned. If this parameter is not used, thenDescribeSnapshots
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.
-
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 interfaceDryRunSupportedRequest<DescribeSnapshotsRequest>
-
toString
public String toString()
Returns a string representation of this object; useful for testing and debugging.- Overrides:
toString
in classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public DescribeSnapshotsRequest clone()
Description copied from class:AmazonWebServiceRequest
Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.- Overrides:
clone
in classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-