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,
]

TimePeriodUnionTypeDef#

# TimePeriodUnionTypeDef definition

TimePeriodUnionTypeDef = Union[
    TimePeriodTypeDef,  # (1)
    TimePeriodExtraOutputTypeDef,  # (2)
]
  1. See TimePeriodTypeDef
  2. See TimePeriodExtraOutputTypeDef

DefinitionUnionTypeDef#

# DefinitionUnionTypeDef definition

DefinitionUnionTypeDef = Union[
    DefinitionTypeDef,  # (1)
    DefinitionExtraOutputTypeDef,  # (2)
]
  1. See DefinitionTypeDef
  2. See DefinitionExtraOutputTypeDef

BudgetUnionTypeDef#

# BudgetUnionTypeDef definition

BudgetUnionTypeDef = Union[
    BudgetTypeDef,  # (1)
    BudgetExtraOutputTypeDef,  # (2)
]
  1. See BudgetTypeDef
  2. See BudgetExtraOutputTypeDef

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],

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,

TimePeriodExtraOutputTypeDef#

# TimePeriodExtraOutputTypeDef definition

class TimePeriodExtraOutputTypeDef(TypedDict):
    Start: NotRequired[datetime],
    End: NotRequired[datetime],

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

TimePeriodOutputTypeDef#

# TimePeriodOutputTypeDef definition

class TimePeriodOutputTypeDef(TypedDict):
    Start: NotRequired[datetime],
    End: NotRequired[datetime],

ResourceTagTypeDef#

# ResourceTagTypeDef definition

class ResourceTagTypeDef(TypedDict):
    Key: str,
    Value: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

IamActionDefinitionExtraOutputTypeDef#

# IamActionDefinitionExtraOutputTypeDef definition

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

ScpActionDefinitionExtraOutputTypeDef#

# ScpActionDefinitionExtraOutputTypeDef definition

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

SsmActionDefinitionExtraOutputTypeDef#

# SsmActionDefinitionExtraOutputTypeDef definition

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

IamActionDefinitionOutputTypeDef#

# IamActionDefinitionOutputTypeDef definition

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

ScpActionDefinitionOutputTypeDef#

# ScpActionDefinitionOutputTypeDef definition

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

SsmActionDefinitionOutputTypeDef#

# SsmActionDefinitionOutputTypeDef definition

class SsmActionDefinitionOutputTypeDef(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

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    ResourceARN: str,
    ResourceTagKeys: Sequence[str],

AutoAdjustDataExtraOutputTypeDef#

# AutoAdjustDataExtraOutputTypeDef definition

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

AutoAdjustDataOutputTypeDef#

# AutoAdjustDataOutputTypeDef definition

class AutoAdjustDataOutputTypeDef(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]],

CalculatedSpendTypeDef#

# CalculatedSpendTypeDef definition

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

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#