Typed dictionaries

Index > AutoScalingPlans > Typed dictionaries

Auto-generated documentation for AutoScalingPlans type annotations stubs module mypy-boto3-autoscaling-plans.

TagFilterTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import TagFilterTypeDef

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

Definition

class TagFilterTypeDef(TypedDict):
    Key: NotRequired[str],
    Values: NotRequired[Sequence[str]],

ResponseMetadataTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ResponseMetadataTypeDef

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

Definition

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

MetricDimensionTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import MetricDimensionTypeDef

def get_value() -> MetricDimensionTypeDef:
    return {
        "Name": ...,
        "Value": ...,
    }

Definition

class MetricDimensionTypeDef(TypedDict):
    Name: str,
    Value: str,

DatapointTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DatapointTypeDef

def get_value() -> DatapointTypeDef:
    return {
        "Timestamp": ...,
    }

Definition

class DatapointTypeDef(TypedDict):
    Timestamp: NotRequired[datetime],
    Value: NotRequired[float],

DeleteScalingPlanRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DeleteScalingPlanRequestRequestTypeDef

def get_value() -> DeleteScalingPlanRequestRequestTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
    }

Definition

class DeleteScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,

PaginatorConfigTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import PaginatorConfigTypeDef

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

Definition

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

DescribeScalingPlanResourcesRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesRequestRequestTypeDef

def get_value() -> DescribeScalingPlanResourcesRequestRequestTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
    }

Definition

class DescribeScalingPlanResourcesRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

GetScalingPlanResourceForecastDataRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import GetScalingPlanResourceForecastDataRequestRequestTypeDef

def get_value() -> GetScalingPlanResourceForecastDataRequestRequestTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
        "ServiceNamespace": ...,
        "ResourceId": ...,
        "ScalableDimension": ...,
        "ForecastDataType": ...,
        "StartTime": ...,
        "EndTime": ...,
    }

Definition

class GetScalingPlanResourceForecastDataRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ForecastDataType: ForecastDataTypeType,  # (3)
    StartTime: Union[datetime, str],
    EndTime: Union[datetime, str],

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See ForecastDataTypeType

PredefinedLoadMetricSpecificationTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import PredefinedLoadMetricSpecificationTypeDef

def get_value() -> PredefinedLoadMetricSpecificationTypeDef:
    return {
        "PredefinedLoadMetricType": ...,
    }

Definition

class PredefinedLoadMetricSpecificationTypeDef(TypedDict):
    PredefinedLoadMetricType: LoadMetricTypeType,  # (1)
    ResourceLabel: NotRequired[str],

1. See LoadMetricTypeType

PredefinedScalingMetricSpecificationTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import PredefinedScalingMetricSpecificationTypeDef

def get_value() -> PredefinedScalingMetricSpecificationTypeDef:
    return {
        "PredefinedScalingMetricType": ...,
    }

Definition

class PredefinedScalingMetricSpecificationTypeDef(TypedDict):
    PredefinedScalingMetricType: ScalingMetricTypeType,  # (1)
    ResourceLabel: NotRequired[str],

1. See ScalingMetricTypeType

ApplicationSourceTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ApplicationSourceTypeDef

def get_value() -> ApplicationSourceTypeDef:
    return {
        "CloudFormationStackARN": ...,
    }

Definition

class ApplicationSourceTypeDef(TypedDict):
    CloudFormationStackARN: NotRequired[str],
    TagFilters: NotRequired[Sequence[TagFilterTypeDef]],  # (1)

1. See TagFilterTypeDef

CreateScalingPlanResponseTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanResponseTypeDef

def get_value() -> CreateScalingPlanResponseTypeDef:
    return {
        "ScalingPlanVersion": ...,
        "ResponseMetadata": ...,
    }

Definition

class CreateScalingPlanResponseTypeDef(TypedDict):
    ScalingPlanVersion: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)

1. See ResponseMetadataTypeDef

CustomizedLoadMetricSpecificationTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import CustomizedLoadMetricSpecificationTypeDef

def get_value() -> CustomizedLoadMetricSpecificationTypeDef:
    return {
        "MetricName": ...,
        "Namespace": ...,
        "Statistic": ...,
    }

Definition

class CustomizedLoadMetricSpecificationTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],

1. See MetricDimensionTypeDef
2. See MetricStatisticType

CustomizedScalingMetricSpecificationTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import CustomizedScalingMetricSpecificationTypeDef

def get_value() -> CustomizedScalingMetricSpecificationTypeDef:
    return {
        "MetricName": ...,
        "Namespace": ...,
        "Statistic": ...,
    }

Definition

class CustomizedScalingMetricSpecificationTypeDef(TypedDict):
    MetricName: str,
    Namespace: str,
    Statistic: MetricStatisticType,  # (2)
    Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]],  # (1)
    Unit: NotRequired[str],

1. See MetricDimensionTypeDef
2. See MetricStatisticType

GetScalingPlanResourceForecastDataResponseTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import GetScalingPlanResourceForecastDataResponseTypeDef

def get_value() -> GetScalingPlanResourceForecastDataResponseTypeDef:
    return {
        "Datapoints": ...,
        "ResponseMetadata": ...,
    }

Definition

class GetScalingPlanResourceForecastDataResponseTypeDef(TypedDict):
    Datapoints: List[DatapointTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See DatapointTypeDef
2. See ResponseMetadataTypeDef

DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef

def get_value() -> DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
    }

Definition

class DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)

1. See PaginatorConfigTypeDef

DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef

def get_value() -> DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef:
    return {
        "ScalingPlanNames": ...,
    }

Definition

class DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef(TypedDict):
    ScalingPlanNames: NotRequired[Sequence[str]],
    ScalingPlanVersion: NotRequired[int],
    ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)

1. See ApplicationSourceTypeDef
2. See PaginatorConfigTypeDef

DescribeScalingPlansRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansRequestRequestTypeDef

def get_value() -> DescribeScalingPlansRequestRequestTypeDef:
    return {
        "ScalingPlanNames": ...,
    }

Definition

class DescribeScalingPlansRequestRequestTypeDef(TypedDict):
    ScalingPlanNames: NotRequired[Sequence[str]],
    ScalingPlanVersion: NotRequired[int],
    ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]],  # (1)
    MaxResults: NotRequired[int],
    NextToken: NotRequired[str],

1. See ApplicationSourceTypeDef

TargetTrackingConfigurationTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import TargetTrackingConfigurationTypeDef

def get_value() -> TargetTrackingConfigurationTypeDef:
    return {
        "TargetValue": ...,
    }

Definition

class TargetTrackingConfigurationTypeDef(TypedDict):
    TargetValue: float,
    PredefinedScalingMetricSpecification: NotRequired[PredefinedScalingMetricSpecificationTypeDef],  # (1)
    CustomizedScalingMetricSpecification: NotRequired[CustomizedScalingMetricSpecificationTypeDef],  # (2)
    DisableScaleIn: NotRequired[bool],
    ScaleOutCooldown: NotRequired[int],
    ScaleInCooldown: NotRequired[int],
    EstimatedInstanceWarmup: NotRequired[int],

1. See PredefinedScalingMetricSpecificationTypeDef
2. See CustomizedScalingMetricSpecificationTypeDef

ScalingInstructionTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ScalingInstructionTypeDef

def get_value() -> ScalingInstructionTypeDef:
    return {
        "ServiceNamespace": ...,
        "ResourceId": ...,
        "ScalableDimension": ...,
        "MinCapacity": ...,
        "MaxCapacity": ...,
        "TargetTrackingConfigurations": ...,
    }

Definition

class ScalingInstructionTypeDef(TypedDict):
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    MinCapacity: int,
    MaxCapacity: int,
    TargetTrackingConfigurations: Sequence[TargetTrackingConfigurationTypeDef],  # (3)
    PredefinedLoadMetricSpecification: NotRequired[PredefinedLoadMetricSpecificationTypeDef],  # (4)
    CustomizedLoadMetricSpecification: NotRequired[CustomizedLoadMetricSpecificationTypeDef],  # (5)
    ScheduledActionBufferTime: NotRequired[int],
    PredictiveScalingMaxCapacityBehavior: NotRequired[PredictiveScalingMaxCapacityBehaviorType],  # (6)
    PredictiveScalingMaxCapacityBuffer: NotRequired[int],
    PredictiveScalingMode: NotRequired[PredictiveScalingModeType],  # (7)
    ScalingPolicyUpdateBehavior: NotRequired[ScalingPolicyUpdateBehaviorType],  # (8)
    DisableDynamicScaling: NotRequired[bool],

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See TargetTrackingConfigurationTypeDef
4. See PredefinedLoadMetricSpecificationTypeDef
5. See CustomizedLoadMetricSpecificationTypeDef
6. See PredictiveScalingMaxCapacityBehaviorType
7. See PredictiveScalingModeType
8. See ScalingPolicyUpdateBehaviorType

ScalingPolicyTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ScalingPolicyTypeDef

def get_value() -> ScalingPolicyTypeDef:
    return {
        "PolicyName": ...,
        "PolicyType": ...,
    }

Definition

class ScalingPolicyTypeDef(TypedDict):
    PolicyName: str,
    PolicyType: PolicyTypeType,  # (1)
    TargetTrackingConfiguration: NotRequired[TargetTrackingConfigurationTypeDef],  # (2)

1. See PolicyTypeType
2. See TargetTrackingConfigurationTypeDef

CreateScalingPlanRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanRequestRequestTypeDef

def get_value() -> CreateScalingPlanRequestRequestTypeDef:
    return {
        "ScalingPlanName": ...,
        "ApplicationSource": ...,
        "ScalingInstructions": ...,
    }

Definition

class CreateScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: Sequence[ScalingInstructionTypeDef],  # (2)

1. See ApplicationSourceTypeDef
2. See ScalingInstructionTypeDef

ScalingPlanTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ScalingPlanTypeDef

def get_value() -> ScalingPlanTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
        "ApplicationSource": ...,
        "ScalingInstructions": ...,
        "StatusCode": ...,
    }

Definition

class ScalingPlanTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: ApplicationSourceTypeDef,  # (1)
    ScalingInstructions: List[ScalingInstructionTypeDef],  # (2)
    StatusCode: ScalingPlanStatusCodeType,  # (3)
    StatusMessage: NotRequired[str],
    StatusStartTime: NotRequired[datetime],
    CreationTime: NotRequired[datetime],

1. See ApplicationSourceTypeDef
2. See ScalingInstructionTypeDef
3. See ScalingPlanStatusCodeType

UpdateScalingPlanRequestRequestTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import UpdateScalingPlanRequestRequestTypeDef

def get_value() -> UpdateScalingPlanRequestRequestTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
    }

Definition

class UpdateScalingPlanRequestRequestTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ApplicationSource: NotRequired[ApplicationSourceTypeDef],  # (1)
    ScalingInstructions: NotRequired[Sequence[ScalingInstructionTypeDef]],  # (2)

1. See ApplicationSourceTypeDef
2. See ScalingInstructionTypeDef

ScalingPlanResourceTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import ScalingPlanResourceTypeDef

def get_value() -> ScalingPlanResourceTypeDef:
    return {
        "ScalingPlanName": ...,
        "ScalingPlanVersion": ...,
        "ServiceNamespace": ...,
        "ResourceId": ...,
        "ScalableDimension": ...,
        "ScalingStatusCode": ...,
    }

Definition

class ScalingPlanResourceTypeDef(TypedDict):
    ScalingPlanName: str,
    ScalingPlanVersion: int,
    ServiceNamespace: ServiceNamespaceType,  # (1)
    ResourceId: str,
    ScalableDimension: ScalableDimensionType,  # (2)
    ScalingStatusCode: ScalingStatusCodeType,  # (4)
    ScalingPolicies: NotRequired[List[ScalingPolicyTypeDef]],  # (3)
    ScalingStatusMessage: NotRequired[str],

1. See ServiceNamespaceType
2. See ScalableDimensionType
3. See ScalingPolicyTypeDef
4. See ScalingStatusCodeType

DescribeScalingPlansResponseTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansResponseTypeDef

def get_value() -> DescribeScalingPlansResponseTypeDef:
    return {
        "ScalingPlans": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeScalingPlansResponseTypeDef(TypedDict):
    ScalingPlans: List[ScalingPlanTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ScalingPlanTypeDef
2. See ResponseMetadataTypeDef

DescribeScalingPlanResourcesResponseTypeDef

Usage Example

from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesResponseTypeDef

def get_value() -> DescribeScalingPlanResourcesResponseTypeDef:
    return {
        "ScalingPlanResources": ...,
        "NextToken": ...,
        "ResponseMetadata": ...,
    }

Definition

class DescribeScalingPlanResourcesResponseTypeDef(TypedDict):
    ScalingPlanResources: List[ScalingPlanResourceTypeDef],  # (1)
    NextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

1. See ScalingPlanResourceTypeDef
2. See ResponseMetadataTypeDef