:doc:`ServiceResource <index>` / Collection / vaults

******
vaults
******



.. py:attribute:: Glacier.ServiceResource.vaults

  A collection of Vault resources.A Vault 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 Vault resources in the collection.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glacier-2012-06-01/ListVaults>`_    


    **Request Syntax**
    ::

      vault_iterator = glacier.vaults.all()
      
      
    
    :rtype: list(:py:class:`glacier.Vault`)
    :returns: A list of Vault resources
    

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

    Creates an iterable of all Vault resources in the collection filtered by kwargs passed to method. A Vault 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/glacier-2012-06-01/ListVaults>`_    


    **Request Syntax**
    ::

      vault_iterator = glacier.vaults.filter(
          marker='string',
          limit='string'
      )
      
    :type marker: string
    :param marker: 

      A string used for pagination. The marker specifies the vault ARN after which the listing of vaults should begin.

      

    
    :type limit: string
    :param limit: 

      The maximum number of vaults to be returned. The default limit is 10. The number of vaults returned might be fewer than the specified limit, but the number of returned vaults never exceeds the limit.

      

    
    
    :rtype: list(:py:class:`glacier.Vault`)
    :returns: A list of Vault resources
    

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

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

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/glacier-2012-06-01/ListVaults>`_    


    **Request Syntax**
    ::

      vault_iterator = glacier.vaults.limit(
          count=123
      )
      
    :type count: integer
    :param count: The limit to the number of resources in the iterable.

    
    
    :rtype: list(:py:class:`glacier.Vault`)
    :returns: A list of Vault resources
    

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

    Creates an iterable of all Vault 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/glacier-2012-06-01/ListVaults>`_    


    **Request Syntax**
    ::

      vault_iterator = glacier.vaults.page_size(
          count=123
      )
      
    :type count: integer
    :param count: The number of items returned by each service call

    
    
    :rtype: list(:py:class:`glacier.Vault`)
    :returns: A list of Vault resources
    