/* * Copyright 2010-2018 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.ec2.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; import com.amazonaws.Request; import com.amazonaws.services.ec2.model.transform.DescribeSnapshotsRequestMarshaller; /** * Container for the parameters to the {@link com.amazonaws.services.ec2.AmazonEC2#describeSnapshots(DescribeSnapshotsRequest) DescribeSnapshots operation}. *
* Describes one or more of the EBS snapshots available to you. Available * snapshots include public snapshots available for any AWS account to * launch, private snapshots that you own, and private snapshots owned by * another AWS account but for which you've been given explicit create * volume permissions. *
** The create volume permissions fall into the following categories: *
* *
* public : The owner of the snapshot granted create volume
* permissions for the snapshot to the all
group. All AWS
* accounts have create volume permissions for these snapshots.
*
* explicit : The owner of the snapshot granted create volume * permissions to a specific AWS account. *
** implicit : An AWS account has implicit create volume * permissions for all snapshots it owns. *
** The list of snapshots returned can be modified by specifying snapshot * IDs, snapshot owners, or AWS accounts with create volume permissions. * If no options are specified, Amazon EC2 returns all snapshots for * which you have create volume permissions. *
** If you specify one or more snapshot IDs, only snapshots that have the * specified IDs are returned. If you specify an invalid snapshot ID, an * error is returned. If you specify a snapshot ID for which you do not * have access, it is not included in the returned results. *
*
* If you specify one or more snapshot owners, only snapshots from the
* specified owners and for which you have access are returned. The
* results can include the AWS account IDs of the specified owners,
* amazon
for snapshots owned by Amazon, or
* self
for snapshots that you own.
*
* If you specify a list of restorable users, only snapshots with create
* snapshot permissions for those users are returned. You can specify AWS
* account IDs (if you own the snapshots), self
for
* snapshots for which you own or have explicit permissions, or
* all
for public snapshots.
*
* If you are describing a long list of snapshots, you can paginate the
* output to make the list more manageable. The MaxResults
* parameter sets the maximum number of results returned in a single
* page. If the list of results exceeds your MaxResults
* value, then that number of results is returned along with a
* NextToken
value that can be passed to a subsequent
* DescribeSnapshots
request to retrieve the remaining
* results.
*
* For more information about EBS snapshots, see * Amazon EBS Snapshots * in the Amazon Elastic Compute Cloud User Guide . *
* * @see com.amazonaws.services.ec2.AmazonEC2#describeSnapshots(DescribeSnapshotsRequest) */ public class DescribeSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, DryRunSupportedRequestDefault: Describes snapshots for which
* you have launch permissions.
*/
private com.amazonaws.internal.ListWithAutoConstructFlag Default: Describes snapshots for which
* you have launch permissions.
*
* @return One or more snapshot IDs. Default: Describes snapshots for which
* you have launch permissions.
*/
public java.util.List Default: Describes snapshots for which
* you have launch permissions.
*
* @param snapshotIds One or more snapshot IDs. Default: Describes snapshots for which
* you have launch permissions.
*/
public void setSnapshotIds(java.util.Collection Default: Describes snapshots for which
* you have launch permissions.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotIds One or more snapshot IDs. Default: Describes snapshots for which
* you have launch permissions.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotIds(String... snapshotIds) {
if (getSnapshotIds() == null) setSnapshotIds(new java.util.ArrayList Default: Describes snapshots for which
* you have launch permissions.
*
* Returns a reference to this object so that method calls can be chained together.
*
* @param snapshotIds One or more snapshot IDs. Default: Describes snapshots for which
* you have launch permissions.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withSnapshotIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param ownerIds Returns the snapshots owned by the specified owner. Multiple owners
* can be specified.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withOwnerIds(String... ownerIds) {
if (getOwnerIds() == null) setOwnerIds(new java.util.ArrayList
* Returns a reference to this object so that method calls can be chained together.
*
* @param ownerIds Returns the snapshots owned by the specified owner. Multiple owners
* can be specified.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withOwnerIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param restorableByUserIds One or more AWS accounts IDs that can create volumes from the
* snapshot.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(String... restorableByUserIds) {
if (getRestorableByUserIds() == null) setRestorableByUserIds(new java.util.ArrayList
* Returns a reference to this object so that method calls can be chained together.
*
* @param restorableByUserIds One or more AWS accounts IDs that can create volumes from the
* snapshot.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withRestorableByUserIds(java.util.Collection
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param filters One or more filters.
* Returns a reference to this object so that method calls can be chained together.
*
* @param nextToken The
* Returns a reference to this object so that method calls can be chained together.
*
* @param maxResults The maximum number of snapshot results returned by
*
*/
private com.amazonaws.internal.ListWithAutoConstructFlagdescription
- 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 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. 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.
*/
private String nextToken;
/**
* 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.
*/
private Integer maxResults;
/**
* One or more snapshot IDs.
*
* @return 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 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 java.util.Listdescription
- 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 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.
*
* @param 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 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(java.util.Collectiondescription
- 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 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
-
* 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 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withFilters(Filter... filters) {
if (getFilters() == null) setFilters(new java.util.ArrayListdescription
- 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 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
-
* 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 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withFilters(java.util.Collectiondescription
- 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 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. 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.
*
* @return 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() {
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.
*
* @param 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 void setNextToken(String nextToken) {
this.nextToken = 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withNextToken(String nextToken) {
this.nextToken = nextToken;
return this;
}
/**
* 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.
*
* @return 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() {
return 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.
*
* @param 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 setMaxResults(Integer maxResults) {
this.maxResults = 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.
*
* @return A reference to this updated object so that method calls can be chained
* together.
*/
public DescribeSnapshotsRequest withMaxResults(Integer maxResults) {
this.maxResults = maxResults;
return this;
}
/**
* This method is intended for internal use only.
* Returns the marshaled request configured with additional parameters to
* enable operation dry-run.
*/
@Override
public Request