Skip to content

Typed dictionaries#

Index > SavingsPlans > Typed dictionaries

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

CreateSavingsPlanRequestRequestTypeDef#

# CreateSavingsPlanRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import CreateSavingsPlanRequestRequestTypeDef

def get_value() -> CreateSavingsPlanRequestRequestTypeDef:
    return {
        "savingsPlanOfferingId": ...,
        "commitment": ...,
    }
# CreateSavingsPlanRequestRequestTypeDef definition

class CreateSavingsPlanRequestRequestTypeDef(TypedDict):
    savingsPlanOfferingId: str,
    commitment: str,
    upfrontPaymentAmount: NotRequired[str],
    purchaseTime: NotRequired[Union[datetime, str]],
    clientToken: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

CreateSavingsPlanResponseTypeDef#

# CreateSavingsPlanResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import CreateSavingsPlanResponseTypeDef

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

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

DeleteQueuedSavingsPlanRequestRequestTypeDef#

# DeleteQueuedSavingsPlanRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DeleteQueuedSavingsPlanRequestRequestTypeDef

def get_value() -> DeleteQueuedSavingsPlanRequestRequestTypeDef:
    return {
        "savingsPlanId": ...,
    }
# DeleteQueuedSavingsPlanRequestRequestTypeDef definition

class DeleteQueuedSavingsPlanRequestRequestTypeDef(TypedDict):
    savingsPlanId: str,

SavingsPlanRateFilterTypeDef#

# SavingsPlanRateFilterTypeDef usage example

from mypy_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 usage example

from mypy_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 usage example

from mypy_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 usage example

from mypy_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 usage example

from mypy_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]],
  1. See SavingsPlanStateType
  2. See SavingsPlanTypeType
  3. See SavingsPlanPaymentOptionType
  4. See SavingsPlanProductTypeType
  5. See CurrencyCodeType

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import ListTagsForResourceRequestRequestTypeDef

def get_value() -> ListTagsForResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
    }
# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import ListTagsForResourceResponseTypeDef

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

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

ParentSavingsPlanOfferingTypeDef#

# ParentSavingsPlanOfferingTypeDef usage example

from mypy_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

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_savingsplans.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }
# ResponseMetadataTypeDef definition

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

SavingsPlanOfferingPropertyTypeDef#

# SavingsPlanOfferingPropertyTypeDef usage example

from mypy_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 usage example

from mypy_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 usage example

from mypy_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

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import TagResourceRequestRequestTypeDef

def get_value() -> TagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tags": ...,
    }
# TagResourceRequestRequestTypeDef definition

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

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import UntagResourceRequestRequestTypeDef

def get_value() -> UntagResourceRequestRequestTypeDef:
    return {
        "resourceArn": ...,
        "tagKeys": ...,
    }
# UntagResourceRequestRequestTypeDef definition

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

DescribeSavingsPlanRatesRequestRequestTypeDef#

# DescribeSavingsPlanRatesRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlanRatesRequestRequestTypeDef

def get_value() -> DescribeSavingsPlanRatesRequestRequestTypeDef:
    return {
        "savingsPlanId": ...,
    }
# DescribeSavingsPlanRatesRequestRequestTypeDef definition

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

DescribeSavingsPlansOfferingRatesRequestRequestTypeDef#

# DescribeSavingsPlansOfferingRatesRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingRatesRequestRequestTypeDef

def get_value() -> DescribeSavingsPlansOfferingRatesRequestRequestTypeDef:
    return {
        "savingsPlanOfferingIds": ...,
    }
# DescribeSavingsPlansOfferingRatesRequestRequestTypeDef definition

class DescribeSavingsPlansOfferingRatesRequestRequestTypeDef(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 SavingsPlanPaymentOptionType
  2. See SavingsPlanTypeType
  3. See SavingsPlanProductTypeType
  4. See SavingsPlanRateServiceCodeType
  5. See SavingsPlanOfferingRateFilterElementTypeDef

DescribeSavingsPlansOfferingsRequestRequestTypeDef#

# DescribeSavingsPlansOfferingsRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingsRequestRequestTypeDef

def get_value() -> DescribeSavingsPlansOfferingsRequestRequestTypeDef:
    return {
        "offeringIds": ...,
    }
# DescribeSavingsPlansOfferingsRequestRequestTypeDef definition

class DescribeSavingsPlansOfferingsRequestRequestTypeDef(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 SavingsPlanPaymentOptionType
  2. See SavingsPlanProductTypeType
  3. See SavingsPlanTypeType
  4. See CurrencyCodeType
  5. See SavingsPlanOfferingFilterElementTypeDef

DescribeSavingsPlansRequestRequestTypeDef#

# DescribeSavingsPlansRequestRequestTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansRequestRequestTypeDef

def get_value() -> DescribeSavingsPlansRequestRequestTypeDef:
    return {
        "savingsPlanArns": ...,
    }
# DescribeSavingsPlansRequestRequestTypeDef definition

class DescribeSavingsPlansRequestRequestTypeDef(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 SavingsPlanStateType
  2. See SavingsPlanFilterTypeDef

DescribeSavingsPlansResponseTypeDef#

# DescribeSavingsPlansResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansResponseTypeDef

def get_value() -> DescribeSavingsPlansResponseTypeDef:
    return {
        "savingsPlans": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeSavingsPlansResponseTypeDef definition

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

SavingsPlanOfferingTypeDef#

# SavingsPlanOfferingTypeDef usage example

from mypy_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 SavingsPlanProductTypeType
  2. See SavingsPlanTypeType
  3. See SavingsPlanPaymentOptionType
  4. See CurrencyCodeType
  5. See SavingsPlanOfferingPropertyTypeDef

SavingsPlanOfferingRateTypeDef#

# SavingsPlanOfferingRateTypeDef usage example

from mypy_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 SavingsPlanOfferingRatePropertyTypeDef

SavingsPlanRateTypeDef#

# SavingsPlanRateTypeDef usage example

from mypy_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 SavingsPlanRatePropertyTypeDef

DescribeSavingsPlansOfferingsResponseTypeDef#

# DescribeSavingsPlansOfferingsResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingsResponseTypeDef

def get_value() -> DescribeSavingsPlansOfferingsResponseTypeDef:
    return {
        "searchResults": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeSavingsPlansOfferingsResponseTypeDef definition

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

DescribeSavingsPlansOfferingRatesResponseTypeDef#

# DescribeSavingsPlansOfferingRatesResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlansOfferingRatesResponseTypeDef

def get_value() -> DescribeSavingsPlansOfferingRatesResponseTypeDef:
    return {
        "searchResults": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeSavingsPlansOfferingRatesResponseTypeDef definition

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

DescribeSavingsPlanRatesResponseTypeDef#

# DescribeSavingsPlanRatesResponseTypeDef usage example

from mypy_boto3_savingsplans.type_defs import DescribeSavingsPlanRatesResponseTypeDef

def get_value() -> DescribeSavingsPlanRatesResponseTypeDef:
    return {
        "savingsPlanId": ...,
        "searchResults": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
# DescribeSavingsPlanRatesResponseTypeDef definition

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