Type definitions#
Index > AutoScalingPlans > Type definitions
Auto-generated documentation for AutoScalingPlans type annotations stubs module mypy-boto3-autoscaling-plans.
TimestampTypeDef#
# TimestampTypeDef definition
TimestampTypeDef = Union[
datetime,
str,
]
ApplicationSourceUnionTypeDef#
# ApplicationSourceUnionTypeDef definition
ApplicationSourceUnionTypeDef = Union[
ApplicationSourceTypeDef, # (1)
ApplicationSourceExtraOutputTypeDef, # (2)
]
ScalingInstructionUnionTypeDef#
# ScalingInstructionUnionTypeDef definition
ScalingInstructionUnionTypeDef = Union[
ScalingInstructionTypeDef, # (1)
ScalingInstructionExtraOutputTypeDef, # (2)
]
TagFilterExtraOutputTypeDef#
# TagFilterExtraOutputTypeDef definition
class TagFilterExtraOutputTypeDef(TypedDict):
Key: NotRequired[str],
Values: NotRequired[List[str]],
TagFilterOutputTypeDef#
# TagFilterOutputTypeDef definition
class TagFilterOutputTypeDef(TypedDict):
Key: NotRequired[str],
Values: NotRequired[List[str]],
TagFilterTypeDef#
# TagFilterTypeDef definition
class TagFilterTypeDef(TypedDict):
Key: NotRequired[str],
Values: NotRequired[Sequence[str]],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
MetricDimensionTypeDef#
# MetricDimensionTypeDef definition
class MetricDimensionTypeDef(TypedDict):
Name: str,
Value: str,
DatapointTypeDef#
# DatapointTypeDef definition
class DatapointTypeDef(TypedDict):
Timestamp: NotRequired[datetime],
Value: NotRequired[float],
DeleteScalingPlanRequestRequestTypeDef#
# DeleteScalingPlanRequestRequestTypeDef definition
class DeleteScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
DescribeScalingPlanResourcesRequestRequestTypeDef#
# DescribeScalingPlanResourcesRequestRequestTypeDef definition
class DescribeScalingPlanResourcesRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
PredefinedLoadMetricSpecificationTypeDef#
# PredefinedLoadMetricSpecificationTypeDef definition
class PredefinedLoadMetricSpecificationTypeDef(TypedDict):
PredefinedLoadMetricType: LoadMetricTypeType, # (1)
ResourceLabel: NotRequired[str],
PredefinedScalingMetricSpecificationTypeDef#
# PredefinedScalingMetricSpecificationTypeDef definition
class PredefinedScalingMetricSpecificationTypeDef(TypedDict):
PredefinedScalingMetricType: ScalingMetricTypeType, # (1)
ResourceLabel: NotRequired[str],
ApplicationSourceExtraOutputTypeDef#
# ApplicationSourceExtraOutputTypeDef definition
class ApplicationSourceExtraOutputTypeDef(TypedDict):
CloudFormationStackARN: NotRequired[str],
TagFilters: NotRequired[List[TagFilterExtraOutputTypeDef]], # (1)
ApplicationSourceOutputTypeDef#
# ApplicationSourceOutputTypeDef definition
class ApplicationSourceOutputTypeDef(TypedDict):
CloudFormationStackARN: NotRequired[str],
TagFilters: NotRequired[List[TagFilterOutputTypeDef]], # (1)
ApplicationSourceTypeDef#
# ApplicationSourceTypeDef definition
class ApplicationSourceTypeDef(TypedDict):
CloudFormationStackARN: NotRequired[str],
TagFilters: NotRequired[Sequence[TagFilterTypeDef]], # (1)
- See TagFilterTypeDef
CreateScalingPlanResponseTypeDef#
# CreateScalingPlanResponseTypeDef definition
class CreateScalingPlanResponseTypeDef(TypedDict):
ScalingPlanVersion: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CustomizedLoadMetricSpecificationExtraOutputTypeDef#
# CustomizedLoadMetricSpecificationExtraOutputTypeDef definition
class CustomizedLoadMetricSpecificationExtraOutputTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[List[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedLoadMetricSpecificationOutputTypeDef#
# CustomizedLoadMetricSpecificationOutputTypeDef definition
class CustomizedLoadMetricSpecificationOutputTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[List[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedLoadMetricSpecificationTypeDef#
# CustomizedLoadMetricSpecificationTypeDef definition
class CustomizedLoadMetricSpecificationTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedScalingMetricSpecificationExtraOutputTypeDef#
# CustomizedScalingMetricSpecificationExtraOutputTypeDef definition
class CustomizedScalingMetricSpecificationExtraOutputTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[List[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedScalingMetricSpecificationOutputTypeDef#
# CustomizedScalingMetricSpecificationOutputTypeDef definition
class CustomizedScalingMetricSpecificationOutputTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[List[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
CustomizedScalingMetricSpecificationTypeDef#
# CustomizedScalingMetricSpecificationTypeDef definition
class CustomizedScalingMetricSpecificationTypeDef(TypedDict):
MetricName: str,
Namespace: str,
Statistic: MetricStatisticType, # (2)
Dimensions: NotRequired[Sequence[MetricDimensionTypeDef]], # (1)
Unit: NotRequired[str],
GetScalingPlanResourceForecastDataResponseTypeDef#
# GetScalingPlanResourceForecastDataResponseTypeDef definition
class GetScalingPlanResourceForecastDataResponseTypeDef(TypedDict):
Datapoints: List[DatapointTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef#
# DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef definition
class DescribeScalingPlanResourcesRequestDescribeScalingPlanResourcesPaginateTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
GetScalingPlanResourceForecastDataRequestRequestTypeDef#
# 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],
TargetTrackingConfigurationExtraOutputTypeDef#
# TargetTrackingConfigurationExtraOutputTypeDef definition
class TargetTrackingConfigurationExtraOutputTypeDef(TypedDict):
TargetValue: float,
PredefinedScalingMetricSpecification: NotRequired[PredefinedScalingMetricSpecificationTypeDef], # (1)
CustomizedScalingMetricSpecification: NotRequired[CustomizedScalingMetricSpecificationExtraOutputTypeDef], # (2)
DisableScaleIn: NotRequired[bool],
ScaleOutCooldown: NotRequired[int],
ScaleInCooldown: NotRequired[int],
EstimatedInstanceWarmup: NotRequired[int],
- See PredefinedScalingMetricSpecificationTypeDef
- See CustomizedScalingMetricSpecificationExtraOutputTypeDef
TargetTrackingConfigurationOutputTypeDef#
# TargetTrackingConfigurationOutputTypeDef definition
class TargetTrackingConfigurationOutputTypeDef(TypedDict):
TargetValue: float,
PredefinedScalingMetricSpecification: NotRequired[PredefinedScalingMetricSpecificationTypeDef], # (1)
CustomizedScalingMetricSpecification: NotRequired[CustomizedScalingMetricSpecificationOutputTypeDef], # (2)
DisableScaleIn: NotRequired[bool],
ScaleOutCooldown: NotRequired[int],
ScaleInCooldown: NotRequired[int],
EstimatedInstanceWarmup: NotRequired[int],
- See PredefinedScalingMetricSpecificationTypeDef
- See CustomizedScalingMetricSpecificationOutputTypeDef
TargetTrackingConfigurationTypeDef#
# 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],
DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef#
# DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef definition
class DescribeScalingPlansRequestDescribeScalingPlansPaginateTypeDef(TypedDict):
ScalingPlanNames: NotRequired[Sequence[str]],
ScalingPlanVersion: NotRequired[int],
ApplicationSources: NotRequired[Sequence[Union[ApplicationSourceTypeDef, ApplicationSourceExtraOutputTypeDef]]], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
DescribeScalingPlansRequestRequestTypeDef#
# DescribeScalingPlansRequestRequestTypeDef definition
class DescribeScalingPlansRequestRequestTypeDef(TypedDict):
ScalingPlanNames: NotRequired[Sequence[str]],
ScalingPlanVersion: NotRequired[int],
ApplicationSources: NotRequired[Sequence[Union[ApplicationSourceTypeDef, ApplicationSourceExtraOutputTypeDef]]], # (1)
MaxResults: NotRequired[int],
NextToken: NotRequired[str],
ScalingInstructionExtraOutputTypeDef#
# ScalingInstructionExtraOutputTypeDef definition
class ScalingInstructionExtraOutputTypeDef(TypedDict):
ServiceNamespace: ServiceNamespaceType, # (1)
ResourceId: str,
ScalableDimension: ScalableDimensionType, # (2)
MinCapacity: int,
MaxCapacity: int,
TargetTrackingConfigurations: List[TargetTrackingConfigurationExtraOutputTypeDef], # (3)
PredefinedLoadMetricSpecification: NotRequired[PredefinedLoadMetricSpecificationTypeDef], # (4)
CustomizedLoadMetricSpecification: NotRequired[CustomizedLoadMetricSpecificationExtraOutputTypeDef], # (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 TargetTrackingConfigurationExtraOutputTypeDef
- See PredefinedLoadMetricSpecificationTypeDef
- See CustomizedLoadMetricSpecificationExtraOutputTypeDef
- See PredictiveScalingMaxCapacityBehaviorType
- See PredictiveScalingModeType
- See ScalingPolicyUpdateBehaviorType
ScalingInstructionOutputTypeDef#
# ScalingInstructionOutputTypeDef definition
class ScalingInstructionOutputTypeDef(TypedDict):
ServiceNamespace: ServiceNamespaceType, # (1)
ResourceId: str,
ScalableDimension: ScalableDimensionType, # (2)
MinCapacity: int,
MaxCapacity: int,
TargetTrackingConfigurations: List[TargetTrackingConfigurationOutputTypeDef], # (3)
PredefinedLoadMetricSpecification: NotRequired[PredefinedLoadMetricSpecificationTypeDef], # (4)
CustomizedLoadMetricSpecification: NotRequired[CustomizedLoadMetricSpecificationOutputTypeDef], # (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 TargetTrackingConfigurationOutputTypeDef
- See PredefinedLoadMetricSpecificationTypeDef
- See CustomizedLoadMetricSpecificationOutputTypeDef
- See PredictiveScalingMaxCapacityBehaviorType
- See PredictiveScalingModeType
- See ScalingPolicyUpdateBehaviorType
ScalingPolicyTypeDef#
# ScalingPolicyTypeDef definition
class ScalingPolicyTypeDef(TypedDict):
PolicyName: str,
PolicyType: PolicyTypeType, # (1)
TargetTrackingConfiguration: NotRequired[TargetTrackingConfigurationOutputTypeDef], # (2)
ScalingInstructionTypeDef#
# 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
ScalingPlanTypeDef#
# ScalingPlanTypeDef definition
class ScalingPlanTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
ApplicationSource: ApplicationSourceOutputTypeDef, # (1)
ScalingInstructions: List[ScalingInstructionOutputTypeDef], # (2)
StatusCode: ScalingPlanStatusCodeType, # (3)
StatusMessage: NotRequired[str],
StatusStartTime: NotRequired[datetime],
CreationTime: NotRequired[datetime],
- See ApplicationSourceOutputTypeDef
- See ScalingInstructionOutputTypeDef
- See ScalingPlanStatusCodeType
ScalingPlanResourceTypeDef#
# 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 definition
class DescribeScalingPlansResponseTypeDef(TypedDict):
ScalingPlans: List[ScalingPlanTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
DescribeScalingPlanResourcesResponseTypeDef#
# DescribeScalingPlanResourcesResponseTypeDef definition
class DescribeScalingPlanResourcesResponseTypeDef(TypedDict):
ScalingPlanResources: List[ScalingPlanResourceTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
NextToken: NotRequired[str],
CreateScalingPlanRequestRequestTypeDef#
# CreateScalingPlanRequestRequestTypeDef definition
class CreateScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ApplicationSource: ApplicationSourceTypeDef, # (1)
ScalingInstructions: Sequence[Union[ScalingInstructionTypeDef, ScalingInstructionExtraOutputTypeDef]], # (2)
UpdateScalingPlanRequestRequestTypeDef#
# UpdateScalingPlanRequestRequestTypeDef definition
class UpdateScalingPlanRequestRequestTypeDef(TypedDict):
ScalingPlanName: str,
ScalingPlanVersion: int,
ApplicationSource: NotRequired[ApplicationSourceTypeDef], # (1)
ScalingInstructions: NotRequired[Sequence[Union[ScalingInstructionTypeDef, ScalingInstructionExtraOutputTypeDef]]], # (2)