Typed dictionaries#
Index > AutoScalingPlans > Typed dictionaries
Auto-generated documentation for AutoScalingPlans type annotations stubs module mypy-boto3-autoscaling-plans.
TagFilterTypeDef#
# TagFilterTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import TagFilterTypeDef
def get_value() -> TagFilterTypeDef:
return {
"Key": ...,
}
# TagFilterTypeDef definition
class TagFilterTypeDef(TypedDict):
Key: NotRequired[str],
Values: NotRequired[Sequence[str]],
CreateScalingPlanResponseTypeDef#
# CreateScalingPlanResponseTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanResponseTypeDef
def get_value() -> CreateScalingPlanResponseTypeDef:
return {
"ScalingPlanVersion": ...,
"ResponseMetadata": ...,
}
# CreateScalingPlanResponseTypeDef definition
class CreateScalingPlanResponseTypeDef(TypedDict):
ScalingPlanVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
MetricDimensionTypeDef#
# MetricDimensionTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import MetricDimensionTypeDef
def get_value() -> MetricDimensionTypeDef:
return {
"Name": ...,
"Value": ...,
}
# MetricDimensionTypeDef definition
class MetricDimensionTypeDef(TypedDict):
Name: str,
Value: str,
DatapointTypeDef#
# DatapointTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DatapointTypeDef
def get_value() -> DatapointTypeDef:
return {
"Timestamp": ...,
}
# DatapointTypeDef definition
class DatapointTypeDef(TypedDict):
Timestamp: NotRequired[datetime],
Value: NotRequired[float],
DeleteScalingPlanRequestRequestTypeDef#
# DeleteScalingPlanRequestRequestTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DeleteScalingPlanRequestRequestTypeDef
def get_value() -> DeleteScalingPlanRequestRequestTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
}
# DeleteScalingPlanRequestRequestTypeDef definition
class DeleteScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef#
# DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef
def get_value() -> DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
}
# DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef definition
class DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
DescribeScalingPlanResourcesRequestRequestTypeDef#
# DescribeScalingPlanResourcesRequestRequestTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesRequestRequestTypeDef
def get_value() -> DescribeScalingPlanResourcesRequestRequestTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
}
# DescribeScalingPlanResourcesRequestRequestTypeDef definition
class DescribeScalingPlanResourcesRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
GetScalingPlanResourceForecastDataRequestRequestTypeDef#
# 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": ...,
}
# GetScalingPlanResourceForecastDataRequestRequestTypeDef 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],
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
PredefinedLoadMetricSpecificationTypeDef#
# PredefinedLoadMetricSpecificationTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import PredefinedLoadMetricSpecificationTypeDef
def get_value() -> PredefinedLoadMetricSpecificationTypeDef:
return {
"PredefinedLoadMetricType": ...,
}
# PredefinedLoadMetricSpecificationTypeDef definition
class PredefinedLoadMetricSpecificationTypeDef(TypedDict):
PredefinedLoadMetricType: LoadMetricTypeType, # (1)
ResourceLabel: NotRequired[str],
PredefinedScalingMetricSpecificationTypeDef#
# PredefinedScalingMetricSpecificationTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import PredefinedScalingMetricSpecificationTypeDef
def get_value() -> PredefinedScalingMetricSpecificationTypeDef:
return {
"PredefinedScalingMetricType": ...,
}
# PredefinedScalingMetricSpecificationTypeDef definition
class PredefinedScalingMetricSpecificationTypeDef(TypedDict):
PredefinedScalingMetricType: ScalingMetricTypeType, # (1)
ResourceLabel: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_autoscaling_plans.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,
ApplicationSourceTypeDef#
# ApplicationSourceTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import ApplicationSourceTypeDef
def get_value() -> ApplicationSourceTypeDef:
return {
"CloudFormationStackARN": ...,
}
# ApplicationSourceTypeDef definition
class ApplicationSourceTypeDef(TypedDict):
CloudFormationStackARN: NotRequired[str],
TagFilters: NotRequired[Sequence[TagFilterTypeDef]], # (1)
- See TagFilterTypeDef
CustomizedLoadMetricSpecificationTypeDef#
# CustomizedLoadMetricSpecificationTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import CustomizedLoadMetricSpecificationTypeDef
def get_value() -> CustomizedLoadMetricSpecificationTypeDef:
return {
"MetricName": ...,
"Namespace": ...,
"Statistic": ...,
}
# CustomizedLoadMetricSpecificationTypeDef definition
class CustomizedLoadMetricSpecificationTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedScalingMetricSpecificationTypeDef#
# CustomizedScalingMetricSpecificationTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import CustomizedScalingMetricSpecificationTypeDef
def get_value() -> CustomizedScalingMetricSpecificationTypeDef:
return {
"MetricName": ...,
"Namespace": ...,
"Statistic": ...,
}
# CustomizedScalingMetricSpecificationTypeDef definition
class CustomizedScalingMetricSpecificationTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
GetScalingPlanResourceForecastDataResponseTypeDef#
# GetScalingPlanResourceForecastDataResponseTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import GetScalingPlanResourceForecastDataResponseTypeDef
def get_value() -> GetScalingPlanResourceForecastDataResponseTypeDef:
return {
"Datapoints": ...,
"ResponseMetadata": ...,
}
# GetScalingPlanResourceForecastDataResponseTypeDef definition
class GetScalingPlanResourceForecastDataResponseTypeDef(TypedDict):
Datapoints: List[DatapointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef#
# DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef
def get_value() -> DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef:
return {
"ScalingPlanNames": ...,
}
# DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef definition
class DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef(TypedDict):
ScalingPlanNames: NotRequired[Sequence[str]],
ScalingPlanVersion: NotRequired[int],
ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
DescribeScalingPlansRequestRequestTypeDef#
# DescribeScalingPlansRequestRequestTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansRequestRequestTypeDef
def get_value() -> DescribeScalingPlansRequestRequestTypeDef:
return {
"ScalingPlanNames": ...,
}
# DescribeScalingPlansRequestRequestTypeDef definition
class DescribeScalingPlansRequestRequestTypeDef(TypedDict):
ScalingPlanNames: NotRequired[Sequence[str]],
ScalingPlanVersion: NotRequired[int],
ApplicationSources: NotRequired[Sequence[ApplicationSourceTypeDef]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
TargetTrackingConfigurationTypeDef#
# TargetTrackingConfigurationTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import TargetTrackingConfigurationTypeDef
def get_value() -> TargetTrackingConfigurationTypeDef:
return {
"TargetValue": ...,
}
# TargetTrackingConfigurationTypeDef 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],
ScalingInstructionTypeDef#
# ScalingInstructionTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import ScalingInstructionTypeDef
def get_value() -> ScalingInstructionTypeDef:
return {
"ServiceNamespace": ...,
"ResourceId": ...,
"ScalableDimension": ...,
"MinCapacity": ...,
"MaxCapacity": ...,
"TargetTrackingConfigurations": ...,
}
# ScalingInstructionTypeDef 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],
- See ServiceNamespaceType
- See ScalableDimensionType
- See TargetTrackingConfigurationTypeDef
- See PredefinedLoadMetricSpecificationTypeDef
- See CustomizedLoadMetricSpecificationTypeDef
- See PredictiveScalingMaxCapacityBehaviorType
- See PredictiveScalingModeType
- See ScalingPolicyUpdateBehaviorType
ScalingPolicyTypeDef#
# ScalingPolicyTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import ScalingPolicyTypeDef
def get_value() -> ScalingPolicyTypeDef:
return {
"PolicyName": ...,
"PolicyType": ...,
}
# ScalingPolicyTypeDef definition
class ScalingPolicyTypeDef(TypedDict):
PolicyName: str,
PolicyType: PolicyTypeType, # (1)
TargetTrackingConfiguration: NotRequired[TargetTrackingConfigurationTypeDef], # (2)
CreateScalingPlanRequestRequestTypeDef#
# CreateScalingPlanRequestRequestTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import CreateScalingPlanRequestRequestTypeDef
def get_value() -> CreateScalingPlanRequestRequestTypeDef:
return {
"ScalingPlanName": ...,
"ApplicationSource": ...,
"ScalingInstructions": ...,
}
# CreateScalingPlanRequestRequestTypeDef definition
class CreateScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ApplicationSource: ApplicationSourceTypeDef, # (1)
ScalingInstructions: Sequence[ScalingInstructionTypeDef], # (2)
ScalingPlanTypeDef#
# ScalingPlanTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import ScalingPlanTypeDef
def get_value() -> ScalingPlanTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
"ApplicationSource": ...,
"ScalingInstructions": ...,
"StatusCode": ...,
}
# ScalingPlanTypeDef 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],
UpdateScalingPlanRequestRequestTypeDef#
# UpdateScalingPlanRequestRequestTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import UpdateScalingPlanRequestRequestTypeDef
def get_value() -> UpdateScalingPlanRequestRequestTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
}
# UpdateScalingPlanRequestRequestTypeDef definition
class UpdateScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
ApplicationSource: NotRequired[ApplicationSourceTypeDef], # (1)
ScalingInstructions: NotRequired[Sequence[ScalingInstructionTypeDef]], # (2)
ScalingPlanResourceTypeDef#
# ScalingPlanResourceTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import ScalingPlanResourceTypeDef
def get_value() -> ScalingPlanResourceTypeDef:
return {
"ScalingPlanName": ...,
"ScalingPlanVersion": ...,
"ServiceNamespace": ...,
"ResourceId": ...,
"ScalableDimension": ...,
"ScalingStatusCode": ...,
}
# ScalingPlanResourceTypeDef 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],
- See ServiceNamespaceType
- See ScalableDimensionType
- See ScalingPolicyTypeDef
- See ScalingStatusCodeType
DescribeScalingPlansResponseTypeDef#
# DescribeScalingPlansResponseTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlansResponseTypeDef
def get_value() -> DescribeScalingPlansResponseTypeDef:
return {
"ScalingPlans": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# DescribeScalingPlansResponseTypeDef definition
class DescribeScalingPlansResponseTypeDef(TypedDict):
ScalingPlans: List[ScalingPlanTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeScalingPlanResourcesResponseTypeDef#
# DescribeScalingPlanResourcesResponseTypeDef usage example
from mypy_boto3_autoscaling_plans.type_defs import DescribeScalingPlanResourcesResponseTypeDef
def get_value() -> DescribeScalingPlanResourcesResponseTypeDef:
return {
"ScalingPlanResources": ...,
"NextToken": ...,
"ResponseMetadata": ...,
}
# DescribeScalingPlanResourcesResponseTypeDef definition
class DescribeScalingPlanResourcesResponseTypeDef(TypedDict):
ScalingPlanResources: List[ScalingPlanResourceTypeDef], # (1)
NextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)