Interface DescribeSnapshotsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
,Ec2Request.Builder
,SdkBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
,SdkPojo
,SdkRequest.Builder
- Enclosing class:
- DescribeSnapshotsRequest
public static interface DescribeSnapshotsRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<DescribeSnapshotsRequest.Builder,DescribeSnapshotsRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description DescribeSnapshotsRequest.Builder
dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.DescribeSnapshotsRequest.Builder
filters(Collection<Filter> filters)
The filters.DescribeSnapshotsRequest.Builder
filters(Consumer<Filter.Builder>... filters)
The filters.DescribeSnapshotsRequest.Builder
filters(Filter... filters)
The filters.DescribeSnapshotsRequest.Builder
maxResults(Integer maxResults)
The maximum number of snapshots to return for this request.DescribeSnapshotsRequest.Builder
nextToken(String nextToken)
The token returned from a previous paginated request.DescribeSnapshotsRequest.Builder
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
DescribeSnapshotsRequest.Builder
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
DescribeSnapshotsRequest.Builder
ownerIds(String... ownerIds)
Scopes the results to snapshots with the specified owners.DescribeSnapshotsRequest.Builder
ownerIds(Collection<String> ownerIds)
Scopes the results to snapshots with the specified owners.DescribeSnapshotsRequest.Builder
restorableByUserIds(String... restorableByUserIds)
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.DescribeSnapshotsRequest.Builder
restorableByUserIds(Collection<String> restorableByUserIds)
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.DescribeSnapshotsRequest.Builder
snapshotIds(String... snapshotIds)
The snapshot IDs.DescribeSnapshotsRequest.Builder
snapshotIds(Collection<String> snapshotIds)
The snapshot IDs.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
filters
DescribeSnapshotsRequest.Builder filters(Collection<Filter> filters)
The filters.
-
description
- A description of the snapshot. -
encrypted
- Indicates whether the snapshot is encrypted (true
|false
) -
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
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
). -
storage-tier
- The storage tier of the snapshot (archive
|standard
). -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id
- The ID of the volume the snapshot is for. -
volume-size
- The size of the volume, in GiB.
- Parameters:
filters
- The filters.-
description
- A description of the snapshot. -
encrypted
- Indicates whether the snapshot is encrypted (true
|false
) -
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
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
). -
storage-tier
- The storage tier of the snapshot (archive
|standard
). -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
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.
-
-
filters
DescribeSnapshotsRequest.Builder filters(Filter... filters)
The filters.
-
description
- A description of the snapshot. -
encrypted
- Indicates whether the snapshot is encrypted (true
|false
) -
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
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
). -
storage-tier
- The storage tier of the snapshot (archive
|standard
). -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id
- The ID of the volume the snapshot is for. -
volume-size
- The size of the volume, in GiB.
- Parameters:
filters
- The filters.-
description
- A description of the snapshot. -
encrypted
- Indicates whether the snapshot is encrypted (true
|false
) -
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
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
). -
storage-tier
- The storage tier of the snapshot (archive
|standard
). -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
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.
-
-
filters
DescribeSnapshotsRequest.Builder filters(Consumer<Filter.Builder>... filters)
The filters.
-
description
- A description of the snapshot. -
encrypted
- Indicates whether the snapshot is encrypted (true
|false
) -
owner-alias
- The owner alias, from an Amazon-maintained list (amazon
). This is not the user-configured Amazon Web Services account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. -
owner-id
- The Amazon Web Services account ID of the owner. We recommend that you use the related parameter instead of this filter. -
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
). -
storage-tier
- The storage tier of the snapshot (archive
|standard
). -
tag
:<key> - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the keyOwner
and the valueTeamA
, specifytag:Owner
for the filter name andTeamA
for the filter value. -
tag-key
- The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. -
volume-id
- The ID of the volume the snapshot is for. -
volume-size
- The size of the volume, in GiB.
Filter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
-
maxResults
DescribeSnapshotsRequest.Builder maxResults(Integer maxResults)
The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, see Pagination.
- Parameters:
maxResults
- The maximum number of snapshots to return for this request. This value can be between 5 and 1,000; if this value is larger than 1,000, only 1,000 results are returned. If this parameter is not used, then the request returns all snapshots. You cannot specify this parameter and the snapshot IDs parameter in the same request. For more information, see Pagination.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
DescribeSnapshotsRequest.Builder nextToken(String nextToken)
The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.
- Parameters:
nextToken
- The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownerIds
DescribeSnapshotsRequest.Builder ownerIds(Collection<String> ownerIds)
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs,
self
, andamazon
.- Parameters:
ownerIds
- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs,self
, andamazon
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
ownerIds
DescribeSnapshotsRequest.Builder ownerIds(String... ownerIds)
Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs,
self
, andamazon
.- Parameters:
ownerIds
- Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs,self
, andamazon
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restorableByUserIds
DescribeSnapshotsRequest.Builder restorableByUserIds(Collection<String> restorableByUserIds)
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
- Parameters:
restorableByUserIds
- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
restorableByUserIds
DescribeSnapshotsRequest.Builder restorableByUserIds(String... restorableByUserIds)
The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.
- Parameters:
restorableByUserIds
- The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotIds
DescribeSnapshotsRequest.Builder snapshotIds(Collection<String> snapshotIds)
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
- Parameters:
snapshotIds
- The snapshot IDs.Default: Describes the snapshots for which you have create volume permissions.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
snapshotIds
DescribeSnapshotsRequest.Builder snapshotIds(String... snapshotIds)
The snapshot IDs.
Default: Describes the snapshots for which you have create volume permissions.
- Parameters:
snapshotIds
- The snapshot IDs.Default: Describes the snapshots for which you have create volume permissions.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dryRun
DescribeSnapshotsRequest.Builder dryRun(Boolean dryRun)
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Parameters:
dryRun
- Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response isDryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-