:doc:`Budgets <../../budgets>` / Paginator / DescribeBudgetActionsForAccount

*******************************
DescribeBudgetActionsForAccount
*******************************



.. py:class:: Budgets.Paginator.DescribeBudgetActionsForAccount

  ::

    
    paginator = client.get_paginator('describe_budget_actions_for_account')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`Budgets.Client.describe_budget_actions_for_account`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/budgets-2016-10-20/DescribeBudgetActionsForAccount>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          AccountId='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type AccountId: string
    :param AccountId: **[REQUIRED]** 

      The account ID of the user. It's a 12-digit number.

      

    
    :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**

      
      ::

        {
            'Actions': [
                {
                    'ActionId': 'string',
                    'BudgetName': 'string',
                    'NotificationType': 'ACTUAL'|'FORECASTED',
                    'ActionType': 'APPLY_IAM_POLICY'|'APPLY_SCP_POLICY'|'RUN_SSM_DOCUMENTS',
                    'ActionThreshold': {
                        'ActionThresholdValue': 123.0,
                        'ActionThresholdType': 'PERCENTAGE'|'ABSOLUTE_VALUE'
                    },
                    'Definition': {
                        'IamActionDefinition': {
                            'PolicyArn': 'string',
                            'Roles': [
                                'string',
                            ],
                            'Groups': [
                                'string',
                            ],
                            'Users': [
                                'string',
                            ]
                        },
                        'ScpActionDefinition': {
                            'PolicyId': 'string',
                            'TargetIds': [
                                'string',
                            ]
                        },
                        'SsmActionDefinition': {
                            'ActionSubType': 'STOP_EC2_INSTANCES'|'STOP_RDS_INSTANCES',
                            'Region': 'string',
                            'InstanceIds': [
                                'string',
                            ]
                        }
                    },
                    'ExecutionRoleArn': 'string',
                    'ApprovalModel': 'AUTOMATIC'|'MANUAL',
                    'Status': 'STANDBY'|'PENDING'|'EXECUTION_IN_PROGRESS'|'EXECUTION_SUCCESS'|'EXECUTION_FAILURE'|'REVERSE_IN_PROGRESS'|'REVERSE_SUCCESS'|'REVERSE_FAILURE'|'RESET_IN_PROGRESS'|'RESET_FAILURE',
                    'Subscribers': [
                        {
                            'SubscriptionType': 'SNS'|'EMAIL',
                            'Address': 'string'
                        },
                    ]
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Actions** *(list) --* 

          A list of the budget action resources information.

          
          

          - *(dict) --* 

            A budget action resource.

            
            

            - **ActionId** *(string) --* 

              A system-generated universally unique identifier (UUID) for the action.

              
            

            - **BudgetName** *(string) --* 

              A string that represents the budget name. The ":" and "\" characters, and the "/action/" substring, aren't allowed.

              
            

            - **NotificationType** *(string) --* 

              The type of a notification. It must be ACTUAL or FORECASTED.

              
            

            - **ActionType** *(string) --* 

              The type of action. This defines the type of tasks that can be carried out by this action. This field also determines the format for definition.

              
            

            - **ActionThreshold** *(dict) --* 

              The trigger threshold of the action.

              
              

              - **ActionThresholdValue** *(float) --* 

                The threshold of a notification.

                
              

              - **ActionThresholdType** *(string) --* 

                The type of threshold for a notification.

                
          
            

            - **Definition** *(dict) --* 

              Where you specify all of the type-specific parameters.

              
              

              - **IamActionDefinition** *(dict) --* 

                The Identity and Access Management (IAM) action definition details.

                
                

                - **PolicyArn** *(string) --* 

                  The Amazon Resource Name (ARN) of the policy to be attached.

                  
                

                - **Roles** *(list) --* 

                  A list of roles to be attached. There must be at least one role.

                  
                  

                  - *(string) --* 
              
                

                - **Groups** *(list) --* 

                  A list of groups to be attached. There must be at least one group.

                  
                  

                  - *(string) --* 
              
                

                - **Users** *(list) --* 

                  A list of users to be attached. There must be at least one user.

                  
                  

                  - *(string) --* 
              
            
              

              - **ScpActionDefinition** *(dict) --* 

                The service control policies (SCPs) action definition details.

                
                

                - **PolicyId** *(string) --* 

                  The policy ID attached.

                  
                

                - **TargetIds** *(list) --* 

                  A list of target IDs.

                  
                  

                  - *(string) --* 
              
            
              

              - **SsmActionDefinition** *(dict) --* 

                The Amazon Web Services Systems Manager (SSM) action definition details.

                
                

                - **ActionSubType** *(string) --* 

                  The action subType.

                  
                

                - **Region** *(string) --* 

                  The Region to run the SSM document.

                  
                

                - **InstanceIds** *(list) --* 

                  The EC2 and RDS instance IDs.

                  
                  

                  - *(string) --* 
              
            
          
            

            - **ExecutionRoleArn** *(string) --* 

              The role passed for action execution and reversion. Roles and actions must be in the same account.

              
            

            - **ApprovalModel** *(string) --* 

              This specifies if the action needs manual or automatic approval.

              
            

            - **Status** *(string) --* 

              The status of the action.

              
            

            - **Subscribers** *(list) --* 

              A list of subscribers.

              
              

              - *(dict) --* 

                The subscriber to a budget notification. The subscriber consists of a subscription type and either an Amazon SNS topic or an email address.

                 

                For example, an email subscriber has the following parameters:

                 

                
                * A ``subscriptionType`` of ``EMAIL``
                 
                * An ``address`` of ``example@example.com``
                

                
                

                - **SubscriptionType** *(string) --* 

                  The type of notification that Amazon Web Services sends to a subscriber.

                  
                

                - **Address** *(string) --* 

                  The address that Amazon Web Services sends budget notifications to, either an SNS topic or an email.

                   

                  When you create a subscriber, the value of ``Address`` can't contain line breaks.

                  
            
          
        
      
    