Skip to content

Type definitions#

Index > Budgets > Type definitions

Auto-generated documentation for Budgets type annotations stubs module mypy-boto3-budgets.

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

ActionThresholdTypeDef#

# ActionThresholdTypeDef definition

class ActionThresholdTypeDef(TypedDict):
    ActionThresholdValue: float,
    ActionThresholdType: ThresholdTypeType,  # (1)
  1. See ThresholdTypeType

SubscriberTypeDef#

# SubscriberTypeDef definition

class SubscriberTypeDef(TypedDict):
    SubscriptionType: SubscriptionTypeType,  # (1)
    Address: str,
  1. See SubscriptionTypeType

HistoricalOptionsTypeDef#

# HistoricalOptionsTypeDef definition

class HistoricalOptionsTypeDef(TypedDict):
    BudgetAdjustmentPeriod: int,
    LookBackAvailablePeriods: NotRequired[int],

NotificationTypeDef#

# NotificationTypeDef definition

class NotificationTypeDef(TypedDict):
    NotificationType: NotificationTypeType,  # (1)
    ComparisonOperator: ComparisonOperatorType,  # (2)
    Threshold: float,
    ThresholdType: NotRequired[ThresholdTypeType],  # (3)
    NotificationState: NotRequired[NotificationStateType],  # (4)
  1. See NotificationTypeType
  2. See ComparisonOperatorType
  3. See ThresholdTypeType
  4. See NotificationStateType

CostTypesTypeDef#

# CostTypesTypeDef definition

class CostTypesTypeDef(TypedDict):
    IncludeTax: NotRequired[bool],
    IncludeSubscription: NotRequired[bool],
    UseBlended: NotRequired[bool],
    IncludeRefund: NotRequired[bool],
    IncludeCredit: NotRequired[bool],
    IncludeUpfront: NotRequired[bool],
    IncludeRecurring: NotRequired[bool],
    IncludeOtherSubscription: NotRequired[bool],
    IncludeSupport: NotRequired[bool],
    IncludeDiscount: NotRequired[bool],
    UseAmortized: NotRequired[bool],

SpendTypeDef#

# SpendTypeDef definition

class SpendTypeDef(TypedDict):
    Amount: str,
    Unit: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

IamActionDefinitionPaginatorTypeDef#

# IamActionDefinitionPaginatorTypeDef definition

class IamActionDefinitionPaginatorTypeDef(TypedDict):
    PolicyArn: str,
    Roles: NotRequired[List[str]],
    Groups: NotRequired[List[str]],
    Users: NotRequired[List[str]],

ScpActionDefinitionPaginatorTypeDef#

# ScpActionDefinitionPaginatorTypeDef definition

class ScpActionDefinitionPaginatorTypeDef(TypedDict):
    PolicyId: str,
    TargetIds: List[str],

SsmActionDefinitionPaginatorTypeDef#

# SsmActionDefinitionPaginatorTypeDef definition

class SsmActionDefinitionPaginatorTypeDef(TypedDict):
    ActionSubType: ActionSubTypeType,  # (1)
    Region: str,
    InstanceIds: List[str],
  1. See ActionSubTypeType

IamActionDefinitionTypeDef#

# IamActionDefinitionTypeDef definition

class IamActionDefinitionTypeDef(TypedDict):
    PolicyArn: str,
    Roles: NotRequired[Sequence[str]],
    Groups: NotRequired[Sequence[str]],
    Users: NotRequired[Sequence[str]],

ScpActionDefinitionTypeDef#

# ScpActionDefinitionTypeDef definition

class ScpActionDefinitionTypeDef(TypedDict):
    PolicyId: str,
    TargetIds: Sequence[str],

SsmActionDefinitionTypeDef#

# SsmActionDefinitionTypeDef definition

class SsmActionDefinitionTypeDef(TypedDict):
    ActionSubType: ActionSubTypeType,  # (1)
    Region: str,
    InstanceIds: Sequence[str],
  1. See ActionSubTypeType

DeleteBudgetActionRequestRequestTypeDef#

# DeleteBudgetActionRequestRequestTypeDef definition

class DeleteBudgetActionRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,

DeleteBudgetRequestRequestTypeDef#

# DeleteBudgetRequestRequestTypeDef definition

class DeleteBudgetRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

DescribeBudgetActionRequestRequestTypeDef#

# DescribeBudgetActionRequestRequestTypeDef definition

class DescribeBudgetActionRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,

DescribeBudgetActionsForAccountRequestRequestTypeDef#

# DescribeBudgetActionsForAccountRequestRequestTypeDef definition

class DescribeBudgetActionsForAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeBudgetActionsForBudgetRequestRequestTypeDef#

# DescribeBudgetActionsForBudgetRequestRequestTypeDef definition

class DescribeBudgetActionsForBudgetRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeBudgetNotificationsForAccountRequestRequestTypeDef#

# DescribeBudgetNotificationsForAccountRequestRequestTypeDef definition

class DescribeBudgetNotificationsForAccountRequestRequestTypeDef(TypedDict):
    AccountId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeBudgetRequestRequestTypeDef#

# DescribeBudgetRequestRequestTypeDef definition

class DescribeBudgetRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,

DescribeBudgetsRequestRequestTypeDef#

# DescribeBudgetsRequestRequestTypeDef definition

class DescribeBudgetsRequestRequestTypeDef(TypedDict):
    AccountId: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

DescribeNotificationsForBudgetRequestRequestTypeDef#

# DescribeNotificationsForBudgetRequestRequestTypeDef definition

class DescribeNotificationsForBudgetRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

ExecuteBudgetActionRequestRequestTypeDef#

# ExecuteBudgetActionRequestRequestTypeDef definition

class ExecuteBudgetActionRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    ExecutionType: ExecutionTypeType,  # (1)
  1. See ExecutionTypeType

AutoAdjustDataPaginatorTypeDef#

# AutoAdjustDataPaginatorTypeDef definition

class AutoAdjustDataPaginatorTypeDef(TypedDict):
    AutoAdjustType: AutoAdjustTypeType,  # (1)
    HistoricalOptions: NotRequired[HistoricalOptionsTypeDef],  # (2)
    LastAutoAdjustTime: NotRequired[datetime],
  1. See AutoAdjustTypeType
  2. See HistoricalOptionsTypeDef

AutoAdjustDataTypeDef#

# AutoAdjustDataTypeDef definition

class AutoAdjustDataTypeDef(TypedDict):
    AutoAdjustType: AutoAdjustTypeType,  # (1)
    HistoricalOptions: NotRequired[HistoricalOptionsTypeDef],  # (2)
    LastAutoAdjustTime: NotRequired[Union[datetime, str]],
  1. See AutoAdjustTypeType
  2. See HistoricalOptionsTypeDef

TimePeriodTypeDef#

# TimePeriodTypeDef definition

class TimePeriodTypeDef(TypedDict):
    Start: NotRequired[Union[datetime, str]],
    End: NotRequired[Union[datetime, str]],

BudgetNotificationsForAccountTypeDef#

# BudgetNotificationsForAccountTypeDef definition

class BudgetNotificationsForAccountTypeDef(TypedDict):
    Notifications: NotRequired[List[NotificationTypeDef]],  # (1)
    BudgetName: NotRequired[str],
  1. See NotificationTypeDef

CreateNotificationRequestRequestTypeDef#

# CreateNotificationRequestRequestTypeDef definition

class CreateNotificationRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    Subscribers: Sequence[SubscriberTypeDef],  # (2)
  1. See NotificationTypeDef
  2. See SubscriberTypeDef

CreateSubscriberRequestRequestTypeDef#

# CreateSubscriberRequestRequestTypeDef definition

class CreateSubscriberRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    Subscriber: SubscriberTypeDef,  # (2)
  1. See NotificationTypeDef
  2. See SubscriberTypeDef

DeleteNotificationRequestRequestTypeDef#

# DeleteNotificationRequestRequestTypeDef definition

class DeleteNotificationRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
  1. See NotificationTypeDef

DeleteSubscriberRequestRequestTypeDef#

# DeleteSubscriberRequestRequestTypeDef definition

class DeleteSubscriberRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    Subscriber: SubscriberTypeDef,  # (2)
  1. See NotificationTypeDef
  2. See SubscriberTypeDef

DescribeSubscribersForNotificationRequestRequestTypeDef#

# DescribeSubscribersForNotificationRequestRequestTypeDef definition

class DescribeSubscribersForNotificationRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See NotificationTypeDef

NotificationWithSubscribersTypeDef#

# NotificationWithSubscribersTypeDef definition

class NotificationWithSubscribersTypeDef(TypedDict):
    Notification: NotificationTypeDef,  # (1)
    Subscribers: Sequence[SubscriberTypeDef],  # (2)
  1. See NotificationTypeDef
  2. See SubscriberTypeDef

UpdateNotificationRequestRequestTypeDef#

# UpdateNotificationRequestRequestTypeDef definition

class UpdateNotificationRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    OldNotification: NotificationTypeDef,  # (1)
    NewNotification: NotificationTypeDef,  # (1)
  1. See NotificationTypeDef
  2. See NotificationTypeDef

UpdateSubscriberRequestRequestTypeDef#

# UpdateSubscriberRequestRequestTypeDef definition

class UpdateSubscriberRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    OldSubscriber: SubscriberTypeDef,  # (2)
    NewSubscriber: SubscriberTypeDef,  # (2)
  1. See NotificationTypeDef
  2. See SubscriberTypeDef
  3. See SubscriberTypeDef

CalculatedSpendTypeDef#

# CalculatedSpendTypeDef definition

class CalculatedSpendTypeDef(TypedDict):
    ActualSpend: SpendTypeDef,  # (1)
    ForecastedSpend: NotRequired[SpendTypeDef],  # (1)
  1. See SpendTypeDef
  2. See SpendTypeDef

CreateBudgetActionResponseTypeDef#

# CreateBudgetActionResponseTypeDef definition

class CreateBudgetActionResponseTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeNotificationsForBudgetResponseTypeDef#

# DescribeNotificationsForBudgetResponseTypeDef definition

class DescribeNotificationsForBudgetResponseTypeDef(TypedDict):
    Notifications: List[NotificationTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See NotificationTypeDef
  2. See ResponseMetadataTypeDef

DescribeSubscribersForNotificationResponseTypeDef#

# DescribeSubscribersForNotificationResponseTypeDef definition

class DescribeSubscribersForNotificationResponseTypeDef(TypedDict):
    Subscribers: List[SubscriberTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SubscriberTypeDef
  2. See ResponseMetadataTypeDef

ExecuteBudgetActionResponseTypeDef#

# ExecuteBudgetActionResponseTypeDef definition

class ExecuteBudgetActionResponseTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    ExecutionType: ExecutionTypeType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ExecutionTypeType
  2. See ResponseMetadataTypeDef

DefinitionPaginatorTypeDef#

# DefinitionPaginatorTypeDef definition

class DefinitionPaginatorTypeDef(TypedDict):
    IamActionDefinition: NotRequired[IamActionDefinitionPaginatorTypeDef],  # (1)
    ScpActionDefinition: NotRequired[ScpActionDefinitionPaginatorTypeDef],  # (2)
    SsmActionDefinition: NotRequired[SsmActionDefinitionPaginatorTypeDef],  # (3)
  1. See IamActionDefinitionPaginatorTypeDef
  2. See ScpActionDefinitionPaginatorTypeDef
  3. See SsmActionDefinitionPaginatorTypeDef

DefinitionTypeDef#

# DefinitionTypeDef definition

class DefinitionTypeDef(TypedDict):
    IamActionDefinition: NotRequired[IamActionDefinitionTypeDef],  # (1)
    ScpActionDefinition: NotRequired[ScpActionDefinitionTypeDef],  # (2)
    SsmActionDefinition: NotRequired[SsmActionDefinitionTypeDef],  # (3)
  1. See IamActionDefinitionTypeDef
  2. See ScpActionDefinitionTypeDef
  3. See SsmActionDefinitionTypeDef

DescribeBudgetActionsForAccountRequestDescribeBudgetActionsForAccountPaginateTypeDef#

# DescribeBudgetActionsForAccountRequestDescribeBudgetActionsForAccountPaginateTypeDef definition

class DescribeBudgetActionsForAccountRequestDescribeBudgetActionsForAccountPaginateTypeDef(TypedDict):
    AccountId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeBudgetActionsForBudgetRequestDescribeBudgetActionsForBudgetPaginateTypeDef#

# DescribeBudgetActionsForBudgetRequestDescribeBudgetActionsForBudgetPaginateTypeDef definition

class DescribeBudgetActionsForBudgetRequestDescribeBudgetActionsForBudgetPaginateTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeBudgetNotificationsForAccountRequestDescribeBudgetNotificationsForAccountPaginateTypeDef#

# DescribeBudgetNotificationsForAccountRequestDescribeBudgetNotificationsForAccountPaginateTypeDef definition

class DescribeBudgetNotificationsForAccountRequestDescribeBudgetNotificationsForAccountPaginateTypeDef(TypedDict):
    AccountId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeBudgetsRequestDescribeBudgetsPaginateTypeDef#

# DescribeBudgetsRequestDescribeBudgetsPaginateTypeDef definition

class DescribeBudgetsRequestDescribeBudgetsPaginateTypeDef(TypedDict):
    AccountId: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeNotificationsForBudgetRequestDescribeNotificationsForBudgetPaginateTypeDef#

# DescribeNotificationsForBudgetRequestDescribeNotificationsForBudgetPaginateTypeDef definition

class DescribeNotificationsForBudgetRequestDescribeNotificationsForBudgetPaginateTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

DescribeSubscribersForNotificationRequestDescribeSubscribersForNotificationPaginateTypeDef#

# DescribeSubscribersForNotificationRequestDescribeSubscribersForNotificationPaginateTypeDef definition

class DescribeSubscribersForNotificationRequestDescribeSubscribersForNotificationPaginateTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    Notification: NotificationTypeDef,  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See NotificationTypeDef
  2. See PaginatorConfigTypeDef

BudgetedAndActualAmountsTypeDef#

# BudgetedAndActualAmountsTypeDef definition

class BudgetedAndActualAmountsTypeDef(TypedDict):
    BudgetedAmount: NotRequired[SpendTypeDef],  # (1)
    ActualAmount: NotRequired[SpendTypeDef],  # (1)
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (3)
  1. See SpendTypeDef
  2. See SpendTypeDef
  3. See TimePeriodTypeDef

DescribeBudgetActionHistoriesRequestDescribeBudgetActionHistoriesPaginateTypeDef#

# DescribeBudgetActionHistoriesRequestDescribeBudgetActionHistoriesPaginateTypeDef definition

class DescribeBudgetActionHistoriesRequestDescribeBudgetActionHistoriesPaginateTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TimePeriodTypeDef
  2. See PaginatorConfigTypeDef

DescribeBudgetActionHistoriesRequestRequestTypeDef#

# DescribeBudgetActionHistoriesRequestRequestTypeDef definition

class DescribeBudgetActionHistoriesRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    ActionId: str,
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TimePeriodTypeDef

DescribeBudgetPerformanceHistoryRequestDescribeBudgetPerformanceHistoryPaginateTypeDef#

# DescribeBudgetPerformanceHistoryRequestDescribeBudgetPerformanceHistoryPaginateTypeDef definition

class DescribeBudgetPerformanceHistoryRequestDescribeBudgetPerformanceHistoryPaginateTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See TimePeriodTypeDef
  2. See PaginatorConfigTypeDef

DescribeBudgetPerformanceHistoryRequestRequestTypeDef#

# DescribeBudgetPerformanceHistoryRequestRequestTypeDef definition

class DescribeBudgetPerformanceHistoryRequestRequestTypeDef(TypedDict):
    AccountId: str,
    BudgetName: str,
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],
  1. See TimePeriodTypeDef

DescribeBudgetNotificationsForAccountResponseTypeDef#

# DescribeBudgetNotificationsForAccountResponseTypeDef definition

class DescribeBudgetNotificationsForAccountResponseTypeDef(TypedDict):
    BudgetNotificationsForAccount: List[BudgetNotificationsForAccountTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BudgetNotificationsForAccountTypeDef
  2. See ResponseMetadataTypeDef

BudgetPaginatorTypeDef#

# BudgetPaginatorTypeDef definition

class BudgetPaginatorTypeDef(TypedDict):
    BudgetName: str,
    TimeUnit: TimeUnitType,  # (4)
    BudgetType: BudgetTypeType,  # (7)
    BudgetLimit: NotRequired[SpendTypeDef],  # (1)
    PlannedBudgetLimits: NotRequired[Dict[str, SpendTypeDef]],  # (2)
    CostFilters: NotRequired[Dict[str, List[str]]],
    CostTypes: NotRequired[CostTypesTypeDef],  # (3)
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (5)
    CalculatedSpend: NotRequired[CalculatedSpendTypeDef],  # (6)
    LastUpdatedTime: NotRequired[datetime],
    AutoAdjustData: NotRequired[AutoAdjustDataPaginatorTypeDef],  # (8)
  1. See SpendTypeDef
  2. See SpendTypeDef
  3. See CostTypesTypeDef
  4. See TimeUnitType
  5. See TimePeriodTypeDef
  6. See CalculatedSpendTypeDef
  7. See BudgetTypeType
  8. See AutoAdjustDataPaginatorTypeDef

BudgetTypeDef#

# BudgetTypeDef definition

class BudgetTypeDef(TypedDict):
    BudgetName: str,
    TimeUnit: TimeUnitType,  # (4)
    BudgetType: BudgetTypeType,  # (7)
    BudgetLimit: NotRequired[SpendTypeDef],  # (1)
    PlannedBudgetLimits: NotRequired[Mapping[str, SpendTypeDef]],  # (2)
    CostFilters: NotRequired[Mapping[str, Sequence[str]]],
    CostTypes: NotRequired[CostTypesTypeDef],  # (3)
    TimePeriod: NotRequired[TimePeriodTypeDef],  # (5)
    CalculatedSpend: NotRequired[CalculatedSpendTypeDef],  # (6)
    LastUpdatedTime: NotRequired[Union[datetime, str]],
    AutoAdjustData: NotRequired[AutoAdjustDataTypeDef],  # (8)
  1. See