:doc:`Volume <index>` / Collection / snapshots

*********
snapshots
*********



.. py:attribute:: EC2.Volume.snapshots

  A collection of Snapshot resources.A Snapshot Collection will include all resources by default, and extreme caution should be taken when performing actions on all resources.

  .. py:method:: all()

    Creates an iterable of all Snapshot resources in the collection.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeSnapshots>`_    


    **Request Syntax**
    ::

      snapshot_iterator = volume.snapshots.all()
      
      
    
    :rtype: list(:py:class:`ec2.Snapshot`)
    :returns: A list of Snapshot resources
    

  .. py:method:: filter(**kwargs)

    Creates an iterable of all Snapshot resources in the collection filtered by kwargs passed to method. A Snapshot collection will include all resources by default if no filters are provided, and extreme caution should be taken when performing actions on all resources.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeSnapshots>`_    


    **Request Syntax**
    ::

      snapshot_iterator = volume.snapshots.filter(
          MaxResults=123,
          NextToken='string',
          OwnerIds=[
              'string',
          ],
          RestorableByUserIds=[
              'string',
          ],
          SnapshotIds=[
              'string',
          ],
          DryRun=True|False,
          
      )
      
    :type MaxResults: integer
    :param MaxResults: 

      The maximum number of items to return for this request. To get the next page of items, make another request with the token returned in the output. For more information, see `Pagination <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/Query-Requests.html#api-pagination>`__.

      

    
    :type NextToken: string
    :param NextToken: 

      The token returned from a previous paginated request. Pagination continues from the end of the items returned by the previous request.

      

    
    :type OwnerIds: list
    :param OwnerIds: 

      Scopes the results to snapshots with the specified owners. You can specify a combination of Amazon Web Services account IDs, ``self``, and ``amazon``.

      

    
      - *(string) --* 

      
  
    :type RestorableByUserIds: list
    :param RestorableByUserIds: 

      The IDs of the Amazon Web Services accounts that can create volumes from the snapshot.

      

    
      - *(string) --* 

      
  
    :type SnapshotIds: list
    :param SnapshotIds: 

      The snapshot IDs.

       

      Default: Describes the snapshots for which you have create volume permissions.

      

    
      - *(string) --* 

      
  
    :type DryRun: boolean
    :param 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 is ``UnauthorizedOperation``.

      

    
    
    :rtype: list(:py:class:`ec2.Snapshot`)
    :returns: A list of Snapshot resources
    

  .. py:method:: limit(**kwargs)

    Creates an iterable up to a specified amount of Snapshot resources in the collection.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeSnapshots>`_    


    **Request Syntax**
    ::

      snapshot_iterator = volume.snapshots.limit(
          count=123
      )
      
    :type count: integer
    :param count: The limit to the number of resources in the iterable.

    
    
    :rtype: list(:py:class:`ec2.Snapshot`)
    :returns: A list of Snapshot resources
    

  .. py:method:: page_size(**kwargs)

    Creates an iterable of all Snapshot resources in the collection, but limits the number of items returned by each service call by the specified amount.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ec2-2016-11-15/DescribeSnapshots>`_    


    **Request Syntax**
    ::

      snapshot_iterator = volume.snapshots.page_size(
          count=123
      )
      
    :type count: integer
    :param count: The number of items returned by each service call

    
    
    :rtype: list(:py:class:`ec2.Snapshot`)
    :returns: A list of Snapshot resources
    