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

****************
placement_groups
****************



.. py:attribute:: EC2.ServiceResource.placement_groups

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

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


    **Request Syntax**
    ::

      placement_group_iterator = ec2.placement_groups.all()
      
      
    
    :rtype: list(:py:class:`ec2.PlacementGroup`)
    :returns: A list of PlacementGroup resources
    

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

    Creates an iterable of all PlacementGroup resources in the collection filtered by kwargs passed to method. A PlacementGroup 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/DescribePlacementGroups>`_    


    **Request Syntax**
    ::

      placement_group_iterator = ec2.placement_groups.filter(
          GroupIds=[
              'string',
          ],
          DryRun=True|False,
          GroupNames=[
              'string',
          ],
          Filters=[
              {
                  'Name': 'string',
                  'Values': [
                      'string',
                  ]
              },
          ]
      )
      
    :type GroupIds: list
    :param GroupIds: 

      The IDs of the placement groups.

      

    
      - *(string) --* 

      
  
    :type DryRun: boolean
    :param DryRun: 

      Checks whether you have the required permissions for the operation, 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``.

      

    
    :type GroupNames: list
    :param GroupNames: 

      The names of the placement groups.

       

      Constraints:

       

      
      * You can specify a name only if the placement group is owned by your account.
       
      * If a placement group is *shared* with your account, specifying the name results in an error. You must use the ``GroupId`` parameter instead.
      

      

    
      - *(string) --* 

      
  
    :type Filters: list
    :param Filters: 

      The filters.

       

      
      * ``group-name`` - The name of the placement group.
       
      * ``group-arn`` - The Amazon Resource Name (ARN) of the placement group.
       
      * ``spread-level`` - The spread level for the placement group ( ``host`` | ``rack``).
       
      * ``state`` - The state of the placement group ( ``pending`` | ``available`` | ``deleting`` | ``deleted``).
       
      * ``strategy`` - The strategy of the placement group ( ``cluster`` | ``spread`` | ``partition``).
       
      * ``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 key ``Owner`` and the value ``TeamA``, specify ``tag:Owner`` for the filter name and ``TeamA`` for the filter value.
       
      * ``tag-key`` - The key of a tag assigned to the resource. Use this filter to find all resources that have a tag with a specific key, regardless of the tag value.
      

      

    
      - *(dict) --* 

        A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

         

        If you specify multiple filters, the filters are joined with an ``AND``, and the request returns only results that match all of the specified filters.

         

        For more information, see `List and filter using the CLI and API <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Filtering.html#Filtering_Resources_CLI>`__ in the *Amazon EC2 User Guide*.

        

      
        - **Name** *(string) --* 

          The name of the filter. Filter names are case-sensitive.

          

        
        - **Values** *(list) --* 

          The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an ``OR``, and the request returns all results that match any of the specified values.

          

        
          - *(string) --* 

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

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

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

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


    **Request Syntax**
    ::

      placement_group_iterator = ec2.placement_groups.limit(
          count=123
      )
      
    :type count: integer
    :param count: The limit to the number of resources in the iterable.

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

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

    Creates an iterable of all PlacementGroup 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/DescribePlacementGroups>`_    


    **Request Syntax**
    ::

      placement_group_iterator = ec2.placement_groups.page_size(
          count=123
      )
      
    :type count: integer
    :param count: The number of items returned by each service call

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