Budgets / Paginator / DescribeBudgetActionHistories

DescribeBudgetActionHistories

class Budgets.Paginator.DescribeBudgetActionHistories

paginator = client.get_paginator('describe_budget_action_histories')

paginate(**kwargs)

Creates an iterator that will paginate through responses from Budgets.Client.describe_budget_action_histories().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    AccountId='string',
    BudgetName='string',
    ActionId='string',
    TimePeriod={
        'Start': datetime(2015, 1, 1),
        'End': datetime(2015, 1, 1)
    },
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• AccountId (string) –

  [REQUIRED]

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

• BudgetName (string) –

  [REQUIRED]

  A string that represents the budget name. The “:” and “" characters aren’t allowed.

• ActionId (string) –

  [REQUIRED]

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

• TimePeriod (dict) –

  The period of time that’s covered by a budget. The period has a start date and an end date. The start date must come before the end date. There are no restrictions on the end date.

  • Start (datetime) –

    The start date for a budget. If you created your budget and didn’t specify a start date, Amazon Web Services defaults to the start of your chosen time period (DAILY, MONTHLY, QUARTERLY, or ANNUALLY). For example, if you created your budget on January 24, 2018, chose DAILY, and didn’t set a start date, Amazon Web Services set your start date to 01/24/18 00:00 UTC. If you chose MONTHLY, Amazon Web Services set your start date to 01/01/18 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

    You can change your start date with the UpdateBudget operation.

  • End (datetime) –

    The end date for a budget. If you didn’t specify an end date, Amazon Web Services set your end date to 06/15/87 00:00 UTC. The defaults are the same for the Billing and Cost Management console and the API.

    After the end date, Amazon Web Services deletes the budget and all the associated notifications and subscribers. You can change your end date with the UpdateBudget operation.

• PaginationConfig (dict) –

  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.

Return type:

dict

Returns:

Response Syntax

{
    'ActionHistories': [
        {
            'Timestamp': datetime(2015, 1, 1),
            'Status': 'STANDBY'|'PENDING'|'EXECUTION_IN_PROGRESS'|'EXECUTION_SUCCESS'|'EXECUTION_FAILURE'|'REVERSE_IN_PROGRESS'|'REVERSE_SUCCESS'|'REVERSE_FAILURE'|'RESET_IN_PROGRESS'|'RESET_FAILURE',
            'EventType': 'SYSTEM'|'CREATE_ACTION'|'DELETE_ACTION'|'UPDATE_ACTION'|'EXECUTE_ACTION',
            'ActionHistoryDetails': {
                'Message': 'string',
                'Action': {
                    '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) –

  • ActionHistories (list) –

    The historical record of the budget action resource.

    • (dict) –

      The historical records for a budget action.

      • Timestamp (datetime) –

        A generic time stamp. In Java, it’s transformed to a Date object.

      • Status (string) –

        The status of action at the time of the event.

      • EventType (string) –

        This distinguishes between whether the events are triggered by the user or are generated by the system.

      • ActionHistoryDetails (dict) –

        The description of the details for the event.

        • Message (string) –

          A generic string.

        • Action (dict) –

          The 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 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.