Type definitions

Index > FreeTier > Type definitions

Auto-generated documentation for FreeTier type annotations stubs module mypy-boto3-freetier.

MonetaryAmountTypeDef

# MonetaryAmountTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import MonetaryAmountTypeDef


def get_value() -> MonetaryAmountTypeDef:
    return {
        "amount": ...,
    }


# MonetaryAmountTypeDef definition

class MonetaryAmountTypeDef(TypedDict):
    amount: float,
    unit: CurrencyCodeType,  # (1)

1. See CurrencyCodeType

DimensionValuesTypeDef

# DimensionValuesTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import DimensionValuesTypeDef


def get_value() -> DimensionValuesTypeDef:
    return {
        "Key": ...,
    }


# DimensionValuesTypeDef definition

class DimensionValuesTypeDef(TypedDict):
    Key: DimensionType,  # (1)
    Values: Sequence[str],
    MatchOptions: Sequence[MatchOptionType],  # (2)

1. See DimensionType
2. See Sequence[MatchOptionType]

FreeTierUsageTypeDef

# FreeTierUsageTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import FreeTierUsageTypeDef


def get_value() -> FreeTierUsageTypeDef:
    return {
        "service": ...,
    }


# FreeTierUsageTypeDef definition

class FreeTierUsageTypeDef(TypedDict):
    service: NotRequired[str],
    operation: NotRequired[str],
    usageType: NotRequired[str],
    region: NotRequired[str],
    actualUsageAmount: NotRequired[float],
    forecastedUsageAmount: NotRequired[float],
    limit: NotRequired[float],
    unit: NotRequired[str],
    description: NotRequired[str],
    freeTierType: NotRequired[str],

GetAccountActivityRequestTypeDef

# GetAccountActivityRequestTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetAccountActivityRequestTypeDef


def get_value() -> GetAccountActivityRequestTypeDef:
    return {
        "activityId": ...,
    }


# GetAccountActivityRequestTypeDef definition

class GetAccountActivityRequestTypeDef(TypedDict):
    activityId: str,
    languageCode: NotRequired[LanguageCodeType],  # (1)

1. See LanguageCodeType

ResponseMetadataTypeDef

# ResponseMetadataTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ResponseMetadataTypeDef


def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
    }


# ResponseMetadataTypeDef definition

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

PaginatorConfigTypeDef

# PaginatorConfigTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import PaginatorConfigTypeDef


def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }


# PaginatorConfigTypeDef definition

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

ListAccountActivitiesRequestTypeDef

# ListAccountActivitiesRequestTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ListAccountActivitiesRequestTypeDef


def get_value() -> ListAccountActivitiesRequestTypeDef:
    return {
        "filterActivityStatuses": ...,
    }


# ListAccountActivitiesRequestTypeDef definition

class ListAccountActivitiesRequestTypeDef(TypedDict):
    filterActivityStatuses: NotRequired[Sequence[ActivityStatusType]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    languageCode: NotRequired[LanguageCodeType],  # (2)

1. See Sequence[ActivityStatusType]
2. See LanguageCodeType

UpgradeAccountPlanRequestTypeDef

# UpgradeAccountPlanRequestTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import UpgradeAccountPlanRequestTypeDef


def get_value() -> UpgradeAccountPlanRequestTypeDef:
    return {
        "accountPlanType": ...,
    }


# UpgradeAccountPlanRequestTypeDef definition

class UpgradeAccountPlanRequestTypeDef(TypedDict):
    accountPlanType: AccountPlanTypeType,  # (1)

1. See AccountPlanTypeType

ActivityRewardTypeDef

# ActivityRewardTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ActivityRewardTypeDef


def get_value() -> ActivityRewardTypeDef:
    return {
        "credit": ...,
    }


# ActivityRewardTypeDef definition

class ActivityRewardTypeDef(TypedDict):
    credit: NotRequired[MonetaryAmountTypeDef],  # (1)

1. See MonetaryAmountTypeDef

ExpressionPaginatorTypeDef

# ExpressionPaginatorTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ExpressionPaginatorTypeDef


def get_value() -> ExpressionPaginatorTypeDef:
    return {
        "Or": ...,
    }


# ExpressionPaginatorTypeDef definition

class ExpressionPaginatorTypeDef(TypedDict):
    Or: NotRequired[Sequence[Mapping[str, Any]]],
    And: NotRequired[Sequence[Mapping[str, Any]]],
    Not: NotRequired[Mapping[str, Any]],
    Dimensions: NotRequired[DimensionValuesTypeDef],  # (1)

1. See DimensionValuesTypeDef

ExpressionTypeDef

# ExpressionTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ExpressionTypeDef


def get_value() -> ExpressionTypeDef:
    return {
        "Or": ...,
    }


# ExpressionTypeDef definition

class ExpressionTypeDef(TypedDict):
    Or: NotRequired[Sequence[Mapping[str, Any]]],
    And: NotRequired[Sequence[Mapping[str, Any]]],
    Not: NotRequired[Mapping[str, Any]],
    Dimensions: NotRequired[DimensionValuesTypeDef],  # (1)

1. See DimensionValuesTypeDef

GetAccountPlanStateResponseTypeDef

# GetAccountPlanStateResponseTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetAccountPlanStateResponseTypeDef


def get_value() -> GetAccountPlanStateResponseTypeDef:
    return {
        "accountId": ...,
    }


# GetAccountPlanStateResponseTypeDef definition

class GetAccountPlanStateResponseTypeDef(TypedDict):
    accountId: str,
    accountPlanType: AccountPlanTypeType,  # (1)
    accountPlanStatus: AccountPlanStatusType,  # (2)
    accountPlanRemainingCredits: MonetaryAmountTypeDef,  # (3)
    accountPlanExpirationDate: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)

1. See AccountPlanTypeType
2. See AccountPlanStatusType
3. See MonetaryAmountTypeDef
4. See ResponseMetadataTypeDef

GetFreeTierUsageResponseTypeDef

# GetFreeTierUsageResponseTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetFreeTierUsageResponseTypeDef


def get_value() -> GetFreeTierUsageResponseTypeDef:
    return {
        "freeTierUsages": ...,
    }


# GetFreeTierUsageResponseTypeDef definition

class GetFreeTierUsageResponseTypeDef(TypedDict):
    freeTierUsages: List[FreeTierUsageTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[FreeTierUsageTypeDef]
2. See ResponseMetadataTypeDef

UpgradeAccountPlanResponseTypeDef

# UpgradeAccountPlanResponseTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import UpgradeAccountPlanResponseTypeDef


def get_value() -> UpgradeAccountPlanResponseTypeDef:
    return {
        "accountId": ...,
    }


# UpgradeAccountPlanResponseTypeDef definition

class UpgradeAccountPlanResponseTypeDef(TypedDict):
    accountId: str,
    accountPlanType: AccountPlanTypeType,  # (1)
    accountPlanStatus: AccountPlanStatusType,  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See AccountPlanTypeType
2. See AccountPlanStatusType
3. See ResponseMetadataTypeDef

ListAccountActivitiesRequestPaginateTypeDef

# ListAccountActivitiesRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ListAccountActivitiesRequestPaginateTypeDef


def get_value() -> ListAccountActivitiesRequestPaginateTypeDef:
    return {
        "filterActivityStatuses": ...,
    }


# ListAccountActivitiesRequestPaginateTypeDef definition

class ListAccountActivitiesRequestPaginateTypeDef(TypedDict):
    filterActivityStatuses: NotRequired[Sequence[ActivityStatusType]],  # (1)
    languageCode: NotRequired[LanguageCodeType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)

1. See Sequence[ActivityStatusType]
2. See LanguageCodeType
3. See PaginatorConfigTypeDef

ActivitySummaryTypeDef

# ActivitySummaryTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ActivitySummaryTypeDef


def get_value() -> ActivitySummaryTypeDef:
    return {
        "activityId": ...,
    }


# ActivitySummaryTypeDef definition

class ActivitySummaryTypeDef(TypedDict):
    activityId: str,
    title: str,
    reward: ActivityRewardTypeDef,  # (1)
    status: ActivityStatusType,  # (2)

1. See ActivityRewardTypeDef
2. See ActivityStatusType

GetAccountActivityResponseTypeDef

# GetAccountActivityResponseTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetAccountActivityResponseTypeDef


def get_value() -> GetAccountActivityResponseTypeDef:
    return {
        "activityId": ...,
    }


# GetAccountActivityResponseTypeDef definition

class GetAccountActivityResponseTypeDef(TypedDict):
    activityId: str,
    title: str,
    description: str,
    status: ActivityStatusType,  # (1)
    instructionsUrl: str,
    reward: ActivityRewardTypeDef,  # (2)
    estimatedTimeToCompleteInMinutes: int,
    expiresAt: datetime.datetime,
    startedAt: datetime.datetime,
    completedAt: datetime.datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)

1. See ActivityStatusType
2. See ActivityRewardTypeDef
3. See ResponseMetadataTypeDef

GetFreeTierUsageRequestPaginateTypeDef

# GetFreeTierUsageRequestPaginateTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetFreeTierUsageRequestPaginateTypeDef


def get_value() -> GetFreeTierUsageRequestPaginateTypeDef:
    return {
        "filter": ...,
    }


# GetFreeTierUsageRequestPaginateTypeDef definition

class GetFreeTierUsageRequestPaginateTypeDef(TypedDict):
    filter: NotRequired[ExpressionPaginatorTypeDef],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ExpressionPaginatorTypeDef
2. See PaginatorConfigTypeDef

GetFreeTierUsageRequestTypeDef

# GetFreeTierUsageRequestTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import GetFreeTierUsageRequestTypeDef


def get_value() -> GetFreeTierUsageRequestTypeDef:
    return {
        "filter": ...,
    }


# GetFreeTierUsageRequestTypeDef definition

class GetFreeTierUsageRequestTypeDef(TypedDict):
    filter: NotRequired[ExpressionTypeDef],  # (1)
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

1. See ExpressionTypeDef

ListAccountActivitiesResponseTypeDef

# ListAccountActivitiesResponseTypeDef TypedDict usage example

from mypy_boto3_freetier.type_defs import ListAccountActivitiesResponseTypeDef


def get_value() -> ListAccountActivitiesResponseTypeDef:
    return {
        "activities": ...,
    }


# ListAccountActivitiesResponseTypeDef definition

class ListAccountActivitiesResponseTypeDef(TypedDict):
    activities: List[ActivitySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],

1. See List[ActivitySummaryTypeDef]
2. See ResponseMetadataTypeDef