Skip to content

Type definitions#

Index > SavingsPlans > Type definitions

Auto-generated documentation for SavingsPlans type annotations stubs module types-boto3-savingsplans.

TimestampTypeDef#

# TimestampTypeDef Union usage example

from types_boto3_savingsplans.type_defs import TimestampTypeDef


def get_value() -> TimestampTypeDef:
    return ...


# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime.datetime,
    str,
]

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef TypedDict usage example

from types_boto3_savingsplans.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],

DeleteQueuedSavingsPlanRequestTypeDef#

# DeleteQueuedSavingsPlanRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DeleteQueuedSavingsPlanRequestTypeDef


def get_value() -> DeleteQueuedSavingsPlanRequestTypeDef:
    return {
        "savingsPlanId": ...,
    }


# DeleteQueuedSavingsPlanRequestTypeDef definition

class DeleteQueuedSavingsPlanRequestTypeDef(TypedDict):
    savingsPlanId: str,

SavingsPlanRateFilterTypeDef#

# SavingsPlanRateFilterTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanRateFilterTypeDef


def get_value() -> SavingsPlanRateFilterTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanRateFilterTypeDef definition

class SavingsPlanRateFilterTypeDef(TypedDict):
    name: NotRequired[SavingsPlanRateFilterNameType],  # (1)
    values: NotRequired[Sequence[str]],
  1. See SavingsPlanRateFilterNameType

SavingsPlanOfferingRateFilterElementTypeDef#

# SavingsPlanOfferingRateFilterElementTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingRateFilterElementTypeDef


def get_value() -> SavingsPlanOfferingRateFilterElementTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanOfferingRateFilterElementTypeDef definition

class SavingsPlanOfferingRateFilterElementTypeDef(TypedDict):
    name: NotRequired[SavingsPlanRateFilterAttributeType],  # (1)
    values: NotRequired[Sequence[str]],
  1. See SavingsPlanRateFilterAttributeType

SavingsPlanOfferingFilterElementTypeDef#

# SavingsPlanOfferingFilterElementTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingFilterElementTypeDef


def get_value() -> SavingsPlanOfferingFilterElementTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanOfferingFilterElementTypeDef definition

class SavingsPlanOfferingFilterElementTypeDef(TypedDict):
    name: NotRequired[SavingsPlanOfferingFilterAttributeType],  # (1)
    values: NotRequired[Sequence[str]],
  1. See SavingsPlanOfferingFilterAttributeType

SavingsPlanFilterTypeDef#

# SavingsPlanFilterTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanFilterTypeDef


def get_value() -> SavingsPlanFilterTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanFilterTypeDef definition

class SavingsPlanFilterTypeDef(TypedDict):
    name: NotRequired[SavingsPlansFilterNameType],  # (1)
    values: NotRequired[Sequence[str]],
  1. See SavingsPlansFilterNameType

SavingsPlanTypeDef#

# SavingsPlanTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanTypeDef


def get_value() -> SavingsPlanTypeDef:
    return {
        "offeringId": ...,
    }


# SavingsPlanTypeDef definition

class SavingsPlanTypeDef(TypedDict):
    offeringId: NotRequired[str],
    savingsPlanId: NotRequired[str],
    savingsPlanArn: NotRequired[str],
    description: NotRequired[str],
    start: NotRequired[str],
    end: NotRequired[str],
    state: NotRequired[SavingsPlanStateType],  # (1)
    region: NotRequired[str],
    ec2InstanceFamily: NotRequired[str],
    savingsPlanType: NotRequired[SavingsPlanTypeType],  # (2)
    paymentOption: NotRequired[SavingsPlanPaymentOptionType],  # (3)
    productTypes: NotRequired[List[SavingsPlanProductTypeType]],  # (4)
    currency: NotRequired[CurrencyCodeType],  # (5)
    commitment: NotRequired[str],
    upfrontPaymentAmount: NotRequired[str],
    recurringPaymentAmount: NotRequired[str],
    termDurationInSeconds: NotRequired[int],
    tags: NotRequired[Dict[str, str]],
    returnableUntil: NotRequired[str],
  1. See SavingsPlanStateType
  2. See SavingsPlanTypeType
  3. See SavingsPlanPaymentOptionType
  4. See List[SavingsPlanProductTypeType]
  5. See CurrencyCodeType

ListTagsForResourceRequestTypeDef#

# ListTagsForResourceRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import ListTagsForResourceRequestTypeDef


def get_value() -> ListTagsForResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# ListTagsForResourceRequestTypeDef definition

class ListTagsForResourceRequestTypeDef(TypedDict):
    resourceArn: str,

ParentSavingsPlanOfferingTypeDef#

# ParentSavingsPlanOfferingTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import ParentSavingsPlanOfferingTypeDef


def get_value() -> ParentSavingsPlanOfferingTypeDef:
    return {
        "offeringId": ...,
    }


# ParentSavingsPlanOfferingTypeDef definition

class ParentSavingsPlanOfferingTypeDef(TypedDict):
    offeringId: NotRequired[str],
    paymentOption: NotRequired[SavingsPlanPaymentOptionType],  # (1)
    planType: NotRequired[SavingsPlanTypeType],  # (2)
    durationSeconds: NotRequired[int],
    currency: NotRequired[CurrencyCodeType],  # (3)
    planDescription: NotRequired[str],
  1. See SavingsPlanPaymentOptionType
  2. See SavingsPlanTypeType
  3. See CurrencyCodeType

ReturnSavingsPlanRequestTypeDef#

# ReturnSavingsPlanRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import ReturnSavingsPlanRequestTypeDef


def get_value() -> ReturnSavingsPlanRequestTypeDef:
    return {
        "savingsPlanId": ...,
    }


# ReturnSavingsPlanRequestTypeDef definition

class ReturnSavingsPlanRequestTypeDef(TypedDict):
    savingsPlanId: str,
    clientToken: NotRequired[str],

SavingsPlanOfferingPropertyTypeDef#

# SavingsPlanOfferingPropertyTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingPropertyTypeDef


def get_value() -> SavingsPlanOfferingPropertyTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanOfferingPropertyTypeDef definition

class SavingsPlanOfferingPropertyTypeDef(TypedDict):
    name: NotRequired[SavingsPlanOfferingPropertyKeyType],  # (1)
    value: NotRequired[str],
  1. See SavingsPlanOfferingPropertyKeyType

SavingsPlanOfferingRatePropertyTypeDef#

# SavingsPlanOfferingRatePropertyTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingRatePropertyTypeDef


def get_value() -> SavingsPlanOfferingRatePropertyTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanOfferingRatePropertyTypeDef definition

class SavingsPlanOfferingRatePropertyTypeDef(TypedDict):
    name: NotRequired[str],
    value: NotRequired[str],

SavingsPlanRatePropertyTypeDef#

# SavingsPlanRatePropertyTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanRatePropertyTypeDef


def get_value() -> SavingsPlanRatePropertyTypeDef:
    return {
        "name": ...,
    }


# SavingsPlanRatePropertyTypeDef definition

class SavingsPlanRatePropertyTypeDef(TypedDict):
    name: NotRequired[SavingsPlanRatePropertyKeyType],  # (1)
    value: NotRequired[str],
  1. See SavingsPlanRatePropertyKeyType

TagResourceRequestTypeDef#

# TagResourceRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import TagResourceRequestTypeDef


def get_value() -> TagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# TagResourceRequestTypeDef definition

class TagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestTypeDef#

# UntagResourceRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import UntagResourceRequestTypeDef


def get_value() -> UntagResourceRequestTypeDef:
    return {
        "resourceArn": ...,
    }


# UntagResourceRequestTypeDef definition

class UntagResourceRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

CreateSavingsPlanRequestTypeDef#

# CreateSavingsPlanRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import CreateSavingsPlanRequestTypeDef


def get_value() -> CreateSavingsPlanRequestTypeDef:
    return {
        "savingsPlanOfferingId": ...,
    }


# CreateSavingsPlanRequestTypeDef definition

class CreateSavingsPlanRequestTypeDef(TypedDict):
    savingsPlanOfferingId: str,
    commitment: str,
    upfrontPaymentAmount: NotRequired[str],
    purchaseTime: NotRequired[TimestampTypeDef],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateSavingsPlanResponseTypeDef#

# CreateSavingsPlanResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import CreateSavingsPlanResponseTypeDef


def get_value() -> CreateSavingsPlanResponseTypeDef:
    return {
        "savingsPlanId": ...,
    }


# CreateSavingsPlanResponseTypeDef definition

class CreateSavingsPlanResponseTypeDef(TypedDict):
    savingsPlanId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import ListTagsForResourceResponseTypeDef


def get_value() -> ListTagsForResourceResponseTypeDef:
    return {
        "tags": ...,
    }


# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ReturnSavingsPlanResponseTypeDef#

# ReturnSavingsPlanResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import ReturnSavingsPlanResponseTypeDef


def get_value() -> ReturnSavingsPlanResponseTypeDef:
    return {
        "savingsPlanId": ...,
    }


# ReturnSavingsPlanResponseTypeDef definition

class ReturnSavingsPlanResponseTypeDef(TypedDict):
    savingsPlanId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DescribeSavingsPlanRatesRequestTypeDef#

# DescribeSavingsPlanRatesRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlanRatesRequestTypeDef


def get_value() -> DescribeSavingsPlanRatesRequestTypeDef:
    return {
        "savingsPlanId": ...,
    }


# DescribeSavingsPlanRatesRequestTypeDef definition

class DescribeSavingsPlanRatesRequestTypeDef(TypedDict):
    savingsPlanId: str,
    filters: NotRequired[Sequence[SavingsPlanRateFilterTypeDef]],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See Sequence[SavingsPlanRateFilterTypeDef]

DescribeSavingsPlansOfferingRatesRequestTypeDef#

# DescribeSavingsPlansOfferingRatesRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingRatesRequestTypeDef


def get_value() -> DescribeSavingsPlansOfferingRatesRequestTypeDef:
    return {
        "savingsPlanOfferingIds": ...,
    }


# DescribeSavingsPlansOfferingRatesRequestTypeDef definition

class DescribeSavingsPlansOfferingRatesRequestTypeDef(TypedDict):
    savingsPlanOfferingIds: NotRequired[Sequence[str]],
    savingsPlanPaymentOptions: NotRequired[Sequence[SavingsPlanPaymentOptionType]],  # (1)
    savingsPlanTypes: NotRequired[Sequence[SavingsPlanTypeType]],  # (2)
    products: NotRequired[Sequence[SavingsPlanProductTypeType]],  # (3)
    serviceCodes: NotRequired[Sequence[SavingsPlanRateServiceCodeType]],  # (4)
    usageTypes: NotRequired[Sequence[str]],
    operations: NotRequired[Sequence[str]],
    filters: NotRequired[Sequence[SavingsPlanOfferingRateFilterElementTypeDef]],  # (5)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See Sequence[SavingsPlanPaymentOptionType]
  2. See Sequence[SavingsPlanTypeType]
  3. See Sequence[SavingsPlanProductTypeType]
  4. See Sequence[SavingsPlanRateServiceCodeType]
  5. See Sequence[SavingsPlanOfferingRateFilterElementTypeDef]

DescribeSavingsPlansOfferingsRequestTypeDef#

# DescribeSavingsPlansOfferingsRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingsRequestTypeDef


def get_value() -> DescribeSavingsPlansOfferingsRequestTypeDef:
    return {
        "offeringIds": ...,
    }


# DescribeSavingsPlansOfferingsRequestTypeDef definition

class DescribeSavingsPlansOfferingsRequestTypeDef(TypedDict):
    offeringIds: NotRequired[Sequence[str]],
    paymentOptions: NotRequired[Sequence[SavingsPlanPaymentOptionType]],  # (1)
    productType: NotRequired[SavingsPlanProductTypeType],  # (2)
    planTypes: NotRequired[Sequence[SavingsPlanTypeType]],  # (3)
    durations: NotRequired[Sequence[int]],
    currencies: NotRequired[Sequence[CurrencyCodeType]],  # (4)
    descriptions: NotRequired[Sequence[str]],
    serviceCodes: NotRequired[Sequence[str]],
    usageTypes: NotRequired[Sequence[str]],
    operations: NotRequired[Sequence[str]],
    filters: NotRequired[Sequence[SavingsPlanOfferingFilterElementTypeDef]],  # (5)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See Sequence[SavingsPlanPaymentOptionType]
  2. See SavingsPlanProductTypeType
  3. See Sequence[SavingsPlanTypeType]
  4. See Sequence[CurrencyCodeType]
  5. See Sequence[SavingsPlanOfferingFilterElementTypeDef]

DescribeSavingsPlansRequestTypeDef#

# DescribeSavingsPlansRequestTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansRequestTypeDef


def get_value() -> DescribeSavingsPlansRequestTypeDef:
    return {
        "savingsPlanArns": ...,
    }


# DescribeSavingsPlansRequestTypeDef definition

class DescribeSavingsPlansRequestTypeDef(TypedDict):
    savingsPlanArns: NotRequired[Sequence[str]],
    savingsPlanIds: NotRequired[Sequence[str]],
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    states: NotRequired[Sequence[SavingsPlanStateType]],  # (1)
    filters: NotRequired[Sequence[SavingsPlanFilterTypeDef]],  # (2)
  1. See Sequence[SavingsPlanStateType]
  2. See Sequence[SavingsPlanFilterTypeDef]

DescribeSavingsPlansResponseTypeDef#

# DescribeSavingsPlansResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansResponseTypeDef


def get_value() -> DescribeSavingsPlansResponseTypeDef:
    return {
        "savingsPlans": ...,
    }


# DescribeSavingsPlansResponseTypeDef definition

class DescribeSavingsPlansResponseTypeDef(TypedDict):
    savingsPlans: List[SavingsPlanTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SavingsPlanTypeDef]
  2. See ResponseMetadataTypeDef

SavingsPlanOfferingTypeDef#

# SavingsPlanOfferingTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingTypeDef


def get_value() -> SavingsPlanOfferingTypeDef:
    return {
        "offeringId": ...,
    }


# SavingsPlanOfferingTypeDef definition

class SavingsPlanOfferingTypeDef(TypedDict):
    offeringId: NotRequired[str],
    productTypes: NotRequired[List[SavingsPlanProductTypeType]],  # (1)
    planType: NotRequired[SavingsPlanTypeType],  # (2)
    description: NotRequired[str],
    paymentOption: NotRequired[SavingsPlanPaymentOptionType],  # (3)
    durationSeconds: NotRequired[int],
    currency: NotRequired[CurrencyCodeType],  # (4)
    serviceCode: NotRequired[str],
    usageType: NotRequired[str],
    operation: NotRequired[str],
    properties: NotRequired[List[SavingsPlanOfferingPropertyTypeDef]],  # (5)
  1. See List[SavingsPlanProductTypeType]
  2. See SavingsPlanTypeType
  3. See SavingsPlanPaymentOptionType
  4. See CurrencyCodeType
  5. See List[SavingsPlanOfferingPropertyTypeDef]

SavingsPlanOfferingRateTypeDef#

# SavingsPlanOfferingRateTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanOfferingRateTypeDef


def get_value() -> SavingsPlanOfferingRateTypeDef:
    return {
        "savingsPlanOffering": ...,
    }


# SavingsPlanOfferingRateTypeDef definition

class SavingsPlanOfferingRateTypeDef(TypedDict):
    savingsPlanOffering: NotRequired[ParentSavingsPlanOfferingTypeDef],  # (1)
    rate: NotRequired[str],
    unit: NotRequired[SavingsPlanRateUnitType],  # (2)
    productType: NotRequired[SavingsPlanProductTypeType],  # (3)
    serviceCode: NotRequired[SavingsPlanRateServiceCodeType],  # (4)
    usageType: NotRequired[str],
    operation: NotRequired[str],
    properties: NotRequired[List[SavingsPlanOfferingRatePropertyTypeDef]],  # (5)
  1. See ParentSavingsPlanOfferingTypeDef
  2. See SavingsPlanRateUnitType
  3. See SavingsPlanProductTypeType
  4. See SavingsPlanRateServiceCodeType
  5. See List[SavingsPlanOfferingRatePropertyTypeDef]

SavingsPlanRateTypeDef#

# SavingsPlanRateTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import SavingsPlanRateTypeDef


def get_value() -> SavingsPlanRateTypeDef:
    return {
        "rate": ...,
    }


# SavingsPlanRateTypeDef definition

class SavingsPlanRateTypeDef(TypedDict):
    rate: NotRequired[str],
    currency: NotRequired[CurrencyCodeType],  # (1)
    unit: NotRequired[SavingsPlanRateUnitType],  # (2)
    productType: NotRequired[SavingsPlanProductTypeType],  # (3)
    serviceCode: NotRequired[SavingsPlanRateServiceCodeType],  # (4)
    usageType: NotRequired[str],
    operation: NotRequired[str],
    properties: NotRequired[List[SavingsPlanRatePropertyTypeDef]],  # (5)
  1. See CurrencyCodeType
  2. See SavingsPlanRateUnitType
  3. See SavingsPlanProductTypeType
  4. See SavingsPlanRateServiceCodeType
  5. See List[SavingsPlanRatePropertyTypeDef]

DescribeSavingsPlansOfferingsResponseTypeDef#

# DescribeSavingsPlansOfferingsResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingsResponseTypeDef


def get_value() -> DescribeSavingsPlansOfferingsResponseTypeDef:
    return {
        "searchResults": ...,
    }


# DescribeSavingsPlansOfferingsResponseTypeDef definition

class DescribeSavingsPlansOfferingsResponseTypeDef(TypedDict):
    searchResults: List[SavingsPlanOfferingTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SavingsPlanOfferingTypeDef]
  2. See ResponseMetadataTypeDef

DescribeSavingsPlansOfferingRatesResponseTypeDef#

# DescribeSavingsPlansOfferingRatesResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingRatesResponseTypeDef


def get_value() -> DescribeSavingsPlansOfferingRatesResponseTypeDef:
    return {
        "searchResults": ...,
    }


# DescribeSavingsPlansOfferingRatesResponseTypeDef definition

class DescribeSavingsPlansOfferingRatesResponseTypeDef(TypedDict):
    searchResults: List[SavingsPlanOfferingRateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SavingsPlanOfferingRateTypeDef]
  2. See ResponseMetadataTypeDef

DescribeSavingsPlanRatesResponseTypeDef#

# DescribeSavingsPlanRatesResponseTypeDef TypedDict usage example

from types_boto3_savingsplans.type_defs import DescribeSavingsPlanRatesResponseTypeDef


def get_value() -> DescribeSavingsPlanRatesResponseTypeDef:
    return {
        "savingsPlanId": ...,
    }


# DescribeSavingsPlanRatesResponseTypeDef definition

class DescribeSavingsPlanRatesResponseTypeDef(TypedDict):
    savingsPlanId: str,
    searchResults: List[SavingsPlanRateTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See List[SavingsPlanRateTypeDef]
  2. See ResponseMetadataTypeDef