:doc:`ECS <../../ecs>` / Paginator / ListAccountSettings

*******************
ListAccountSettings
*******************



.. py:class:: ECS.Paginator.ListAccountSettings

  ::

    
    paginator = client.get_paginator('list_account_settings')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`ECS.Client.list_account_settings`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/ecs-2014-11-13/ListAccountSettings>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          name='serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat'|'awsvpcTrunking'|'containerInsights'|'fargateFIPSMode'|'tagResourceAuthorization'|'fargateTaskRetirementWaitPeriod'|'guardDutyActivate'|'defaultLogDriverMode'|'fargateEventWindows',
          value='string',
          principalArn='string',
          effectiveSettings=True|False,
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type name: string
    :param name: 

      The name of the account setting you want to list the settings for.

      

    
    :type value: string
    :param value: 

      The value of the account settings to filter results with. You must also specify an account setting name to use this parameter.

      

    
    :type principalArn: string
    :param principalArn: 

      The ARN of the principal, which can be a user, role, or the root user. If this field is omitted, the account settings are listed only for the authenticated user.

       

      In order to use this parameter, you must be the root user, or the principal.

       

      .. note::

        

        Federated users assume the account setting of the root user and can't have explicit account settings set for them.

        

      

    
    :type effectiveSettings: boolean
    :param effectiveSettings: 

      Determines whether to return the effective settings. If ``true``, the account settings for the root user or the default setting for the ``principalArn`` are returned. If ``false``, the account settings for the ``principalArn`` are returned if they're set. Otherwise, no account settings are returned.

      

    
    :type PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'settings': [
                {
                    'name': 'serviceLongArnFormat'|'taskLongArnFormat'|'containerInstanceLongArnFormat'|'awsvpcTrunking'|'containerInsights'|'fargateFIPSMode'|'tagResourceAuthorization'|'fargateTaskRetirementWaitPeriod'|'guardDutyActivate'|'defaultLogDriverMode'|'fargateEventWindows',
                    'value': 'string',
                    'principalArn': 'string',
                    'type': 'user'|'aws_managed'
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **settings** *(list) --* 

          The account settings for the resource.

          
          

          - *(dict) --* 

            The current account setting for a resource.

            
            

            - **name** *(string) --* 

              The Amazon ECS resource name.

              
            

            - **value** *(string) --* 

              Determines whether the account setting is on or off for the specified resource.

              
            

            - **principalArn** *(string) --* 

              The ARN of the principal. It can be a user, role, or the root user. If this field is omitted, the authenticated user is assumed.

              
            

            - **type** *(string) --* 

              Indicates whether Amazon Web Services manages the account setting, or if the user manages it.

               

              ``aws_managed`` account settings are read-only, as Amazon Web Services manages such on the customer's behalf. Currently, the ``guardDutyActivate`` account setting is the only one Amazon Web Services manages.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    