public static interface DescribeSnapshotsRequest.Builder extends EC2Request.Builder, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
Modifier and Type | Method and Description |
---|---|
DescribeSnapshotsRequest.Builder |
filters(Collection<Filter> filters)
One or more filters.
|
DescribeSnapshotsRequest.Builder |
filters(Filter... filters)
One or more filters.
|
DescribeSnapshotsRequest.Builder |
maxResults(Integer maxResults)
The maximum number of snapshot results returned by
DescribeSnapshots in paginated output. |
DescribeSnapshotsRequest.Builder |
nextToken(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.Builder |
ownerIds(Collection<String> ownerIds)
Returns the snapshots owned by the specified owner.
|
DescribeSnapshotsRequest.Builder |
ownerIds(String... ownerIds)
Returns the snapshots owned by the specified owner.
|
DescribeSnapshotsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
DescribeSnapshotsRequest.Builder |
restorableByUserIds(Collection<String> restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.
|
DescribeSnapshotsRequest.Builder |
restorableByUserIds(String... restorableByUserIds)
One or more AWS accounts IDs that can create volumes from the snapshot.
|
DescribeSnapshotsRequest.Builder |
snapshotIds(Collection<String> snapshotIds)
One or more snapshot IDs.
|
DescribeSnapshotsRequest.Builder |
snapshotIds(String... snapshotIds)
One or more snapshot IDs.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
DescribeSnapshotsRequest.Builder filters(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.
DescribeSnapshotsRequest.Builder filters(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.
DescribeSnapshotsRequest.Builder maxResults(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.DescribeSnapshotsRequest.Builder nextToken(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.DescribeSnapshotsRequest.Builder ownerIds(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.DescribeSnapshotsRequest.Builder ownerIds(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.DescribeSnapshotsRequest.Builder restorableByUserIds(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.DescribeSnapshotsRequest.Builder restorableByUserIds(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.DescribeSnapshotsRequest.Builder snapshotIds(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.
DescribeSnapshotsRequest.Builder snapshotIds(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.
DescribeSnapshotsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.