AutoScalingClient#
Index > AutoScaling > AutoScalingClient
Auto-generated documentation for AutoScaling type annotations stubs module mypy-boto3-autoscaling.
AutoScalingClient#
Type annotations and code completion for boto3.client("autoscaling").
boto3 documentation
# AutoScalingClient usage example
from boto3.session import Session
from mypy_boto3_autoscaling.client import AutoScalingClient
def get_autoscaling_client() -> AutoScalingClient:
return Session().client("autoscaling")Exceptions#
boto3 client exceptions are generated in runtime.
This class provides code completion for boto3.client("autoscaling").exceptions structure.
# Exceptions.exceptions usage example
client = boto3.client("autoscaling")
try:
do_something(client)
except (
client.exceptions.ActiveInstanceRefreshNotFoundFault,
client.exceptions.AlreadyExistsFault,
client.exceptions.ClientError,
client.exceptions.InstanceRefreshInProgressFault,
client.exceptions.InvalidNextToken,
client.exceptions.IrreversibleInstanceRefreshFault,
client.exceptions.LimitExceededFault,
client.exceptions.ResourceContentionFault,
client.exceptions.ResourceInUseFault,
client.exceptions.ScalingActivityInProgressFault,
client.exceptions.ServiceLinkedRoleFailure,
) as e:
print(e)# Exceptions.exceptions type checking example
from mypy_boto3_autoscaling.client import Exceptions
def handle_error(exc: Exceptions.ActiveInstanceRefreshNotFoundFault) -> None:
...Methods#
attach_instances#
Attaches one or more EC2 instances to the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").attach_instances method.
boto3 documentation
# attach_instances method definition
def attach_instances(
self,
*,
AutoScalingGroupName: str,
InstanceIds: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# attach_instances method usage example with argument unpacking
kwargs: AttachInstancesQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.attach_instances(**kwargs)attach_load_balancer_target_groups#
.
Type annotations and code completion for boto3.client("autoscaling").attach_load_balancer_target_groups method.
boto3 documentation
# attach_load_balancer_target_groups method definition
def attach_load_balancer_target_groups(
self,
*,
AutoScalingGroupName: str,
TargetGroupARNs: Sequence[str],
) -> Dict[str, Any]:
...# attach_load_balancer_target_groups method usage example with argument unpacking
kwargs: AttachLoadBalancerTargetGroupsTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TargetGroupARNs": ...,
}
parent.attach_load_balancer_target_groups(**kwargs)attach_load_balancers#
.
Type annotations and code completion for boto3.client("autoscaling").attach_load_balancers method.
boto3 documentation
# attach_load_balancers method definition
def attach_load_balancers(
self,
*,
AutoScalingGroupName: str,
LoadBalancerNames: Sequence[str],
) -> Dict[str, Any]:
...# attach_load_balancers method usage example with argument unpacking
kwargs: AttachLoadBalancersTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"LoadBalancerNames": ...,
}
parent.attach_load_balancers(**kwargs)attach_traffic_sources#
Attaches one or more traffic sources to the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").attach_traffic_sources method.
boto3 documentation
# attach_traffic_sources method definition
def attach_traffic_sources(
self,
*,
AutoScalingGroupName: str,
TrafficSources: Sequence[TrafficSourceIdentifierTypeDef], # (1)
) -> Dict[str, Any]:
...# attach_traffic_sources method usage example with argument unpacking
kwargs: AttachTrafficSourcesTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TrafficSources": ...,
}
parent.attach_traffic_sources(**kwargs)batch_delete_scheduled_action#
Deletes one or more scheduled actions for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").batch_delete_scheduled_action method.
boto3 documentation
# batch_delete_scheduled_action method definition
def batch_delete_scheduled_action(
self,
*,
AutoScalingGroupName: str,
ScheduledActionNames: Sequence[str],
) -> BatchDeleteScheduledActionAnswerTypeDef: # (1)
...# batch_delete_scheduled_action method usage example with argument unpacking
kwargs: BatchDeleteScheduledActionTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ScheduledActionNames": ...,
}
parent.batch_delete_scheduled_action(**kwargs)batch_put_scheduled_update_group_action#
Creates or updates one or more scheduled scaling actions for an Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").batch_put_scheduled_update_group_action method.
boto3 documentation
# batch_put_scheduled_update_group_action method definition
def batch_put_scheduled_update_group_action(
self,
*,
AutoScalingGroupName: str,
ScheduledUpdateGroupActions: Sequence[ScheduledUpdateGroupActionRequestTypeDef], # (1)
) -> BatchPutScheduledUpdateGroupActionAnswerTypeDef: # (2)
...# batch_put_scheduled_update_group_action method usage example with argument unpacking
kwargs: BatchPutScheduledUpdateGroupActionTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ScheduledUpdateGroupActions": ...,
}
parent.batch_put_scheduled_update_group_action(**kwargs)can_paginate#
Check if an operation can be paginated.
Type annotations and code completion for boto3.client("autoscaling").can_paginate method.
boto3 documentation
# can_paginate method definition
def can_paginate(
self,
operation_name: str,
) -> bool:
...cancel_instance_refresh#
Cancels an instance refresh or rollback that is in progress.
Type annotations and code completion for boto3.client("autoscaling").cancel_instance_refresh method.
boto3 documentation
# cancel_instance_refresh method definition
def cancel_instance_refresh(
self,
*,
AutoScalingGroupName: str,
) -> CancelInstanceRefreshAnswerTypeDef: # (1)
...# cancel_instance_refresh method usage example with argument unpacking
kwargs: CancelInstanceRefreshTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.cancel_instance_refresh(**kwargs)close#
Closes underlying endpoint connections.
Type annotations and code completion for boto3.client("autoscaling").close method.
boto3 documentation
# close method definition
def close(
self,
) -> None:
...complete_lifecycle_action#
Completes the lifecycle action for the specified token or instance with the specified result.
Type annotations and code completion for boto3.client("autoscaling").complete_lifecycle_action method.
boto3 documentation
# complete_lifecycle_action method definition
def complete_lifecycle_action(
self,
*,
LifecycleHookName: str,
AutoScalingGroupName: str,
LifecycleActionResult: str,
LifecycleActionToken: str = ...,
InstanceId: str = ...,
) -> Dict[str, Any]:
...# complete_lifecycle_action method usage example with argument unpacking
kwargs: CompleteLifecycleActionTypeRequestTypeDef = { # (1)
"LifecycleHookName": ...,
"AutoScalingGroupName": ...,
"LifecycleActionResult": ...,
}
parent.complete_lifecycle_action(**kwargs)create_auto_scaling_group#
We strongly recommend using a launch template when calling this operation to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2. Creates an Auto Scaling group with the specified name and attributes.
Type annotations and code completion for boto3.client("autoscaling").create_auto_scaling_group method.
boto3 documentation
# create_auto_scaling_group method definition
def create_auto_scaling_group(
self,
*,
AutoScalingGroupName: str,
MinSize: int,
MaxSize: int,
LaunchConfigurationName: str = ...,
LaunchTemplate: LaunchTemplateSpecificationTypeDef = ..., # (1)
MixedInstancesPolicy: MixedInstancesPolicyTypeDef = ..., # (2)
InstanceId: str = ...,
DesiredCapacity: int = ...,
DefaultCooldown: int = ...,
AvailabilityZones: Sequence[str] = ...,
LoadBalancerNames: Sequence[str] = ...,
TargetGroupARNs: Sequence[str] = ...,
HealthCheckType: str = ...,
HealthCheckGracePeriod: int = ...,
PlacementGroup: str = ...,
VPCZoneIdentifier: str = ...,
TerminationPolicies: Sequence[str] = ...,
NewInstancesProtectedFromScaleIn: bool = ...,
CapacityRebalance: bool = ...,
LifecycleHookSpecificationList: Sequence[LifecycleHookSpecificationTypeDef] = ..., # (3)
Tags: Sequence[TagTypeDef] = ..., # (4)
ServiceLinkedRoleARN: str = ...,
MaxInstanceLifetime: int = ...,
Context: str = ...,
DesiredCapacityType: str = ...,
DefaultInstanceWarmup: int = ...,
TrafficSources: Sequence[TrafficSourceIdentifierTypeDef] = ..., # (5)
) -> EmptyResponseMetadataTypeDef: # (6)
...- See LaunchTemplateSpecificationTypeDef
- See MixedInstancesPolicyTypeDef
- See LifecycleHookSpecificationTypeDef
- See TagTypeDef
- See TrafficSourceIdentifierTypeDef
- See EmptyResponseMetadataTypeDef
# create_auto_scaling_group method usage example with argument unpacking
kwargs: CreateAutoScalingGroupTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"MinSize": ...,
"MaxSize": ...,
}
parent.create_auto_scaling_group(**kwargs)create_launch_configuration#
Creates a launch configuration.
Type annotations and code completion for boto3.client("autoscaling").create_launch_configuration method.
boto3 documentation
# create_launch_configuration method definition
def create_launch_configuration(
self,
*,
LaunchConfigurationName: str,
ImageId: str = ...,
KeyName: str = ...,
SecurityGroups: Sequence[str] = ...,
ClassicLinkVPCId: str = ...,
ClassicLinkVPCSecurityGroups: Sequence[str] = ...,
UserData: str = ...,
InstanceId: str = ...,
InstanceType: str = ...,
KernelId: str = ...,
RamdiskId: str = ...,
BlockDeviceMappings: Sequence[BlockDeviceMappingTypeDef] = ..., # (1)
InstanceMonitoring: InstanceMonitoringTypeDef = ..., # (2)
SpotPrice: str = ...,
IamInstanceProfile: str = ...,
EbsOptimized: bool = ...,
AssociatePublicIpAddress: bool = ...,
PlacementTenancy: str = ...,
MetadataOptions: InstanceMetadataOptionsTypeDef = ..., # (3)
) -> EmptyResponseMetadataTypeDef: # (4)
...- See BlockDeviceMappingTypeDef
- See InstanceMonitoringTypeDef
- See InstanceMetadataOptionsTypeDef
- See EmptyResponseMetadataTypeDef
# create_launch_configuration method usage example with argument unpacking
kwargs: CreateLaunchConfigurationTypeRequestTypeDef = { # (1)
"LaunchConfigurationName": ...,
}
parent.create_launch_configuration(**kwargs)create_or_update_tags#
Creates or updates tags for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").create_or_update_tags method.
boto3 documentation
# create_or_update_tags method definition
def create_or_update_tags(
self,
*,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# create_or_update_tags method usage example with argument unpacking
kwargs: CreateOrUpdateTagsTypeRequestTypeDef = { # (1)
"Tags": ...,
}
parent.create_or_update_tags(**kwargs)delete_auto_scaling_group#
Deletes the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").delete_auto_scaling_group method.
boto3 documentation
# delete_auto_scaling_group method definition
def delete_auto_scaling_group(
self,
*,
AutoScalingGroupName: str,
ForceDelete: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_auto_scaling_group method usage example with argument unpacking
kwargs: DeleteAutoScalingGroupTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.delete_auto_scaling_group(**kwargs)delete_launch_configuration#
Deletes the specified launch configuration.
Type annotations and code completion for boto3.client("autoscaling").delete_launch_configuration method.
boto3 documentation
# delete_launch_configuration method definition
def delete_launch_configuration(
self,
*,
LaunchConfigurationName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_launch_configuration method usage example with argument unpacking
kwargs: LaunchConfigurationNameTypeRequestTypeDef = { # (1)
"LaunchConfigurationName": ...,
}
parent.delete_launch_configuration(**kwargs)delete_lifecycle_hook#
Deletes the specified lifecycle hook.
Type annotations and code completion for boto3.client("autoscaling").delete_lifecycle_hook method.
boto3 documentation
# delete_lifecycle_hook method definition
def delete_lifecycle_hook(
self,
*,
LifecycleHookName: str,
AutoScalingGroupName: str,
) -> Dict[str, Any]:
...# delete_lifecycle_hook method usage example with argument unpacking
kwargs: DeleteLifecycleHookTypeRequestTypeDef = { # (1)
"LifecycleHookName": ...,
"AutoScalingGroupName": ...,
}
parent.delete_lifecycle_hook(**kwargs)delete_notification_configuration#
Deletes the specified notification.
Type annotations and code completion for boto3.client("autoscaling").delete_notification_configuration method.
boto3 documentation
# delete_notification_configuration method definition
def delete_notification_configuration(
self,
*,
AutoScalingGroupName: str,
TopicARN: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_notification_configuration method usage example with argument unpacking
kwargs: DeleteNotificationConfigurationTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TopicARN": ...,
}
parent.delete_notification_configuration(**kwargs)delete_policy#
Deletes the specified scaling policy.
Type annotations and code completion for boto3.client("autoscaling").delete_policy method.
boto3 documentation
# delete_policy method definition
def delete_policy(
self,
*,
PolicyName: str,
AutoScalingGroupName: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_policy method usage example with argument unpacking
kwargs: DeletePolicyTypeRequestTypeDef = { # (1)
"PolicyName": ...,
}
parent.delete_policy(**kwargs)delete_scheduled_action#
Deletes the specified scheduled action.
Type annotations and code completion for boto3.client("autoscaling").delete_scheduled_action method.
boto3 documentation
# delete_scheduled_action method definition
def delete_scheduled_action(
self,
*,
AutoScalingGroupName: str,
ScheduledActionName: str,
) -> EmptyResponseMetadataTypeDef: # (1)
...# delete_scheduled_action method usage example with argument unpacking
kwargs: DeleteScheduledActionTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ScheduledActionName": ...,
}
parent.delete_scheduled_action(**kwargs)delete_tags#
Deletes the specified tags.
Type annotations and code completion for boto3.client("autoscaling").delete_tags method.
boto3 documentation
# delete_tags method definition
def delete_tags(
self,
*,
Tags: Sequence[TagTypeDef], # (1)
) -> EmptyResponseMetadataTypeDef: # (2)
...# delete_tags method usage example with argument unpacking
kwargs: DeleteTagsTypeRequestTypeDef = { # (1)
"Tags": ...,
}
parent.delete_tags(**kwargs)delete_warm_pool#
Deletes the warm pool for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").delete_warm_pool method.
boto3 documentation
# delete_warm_pool method definition
def delete_warm_pool(
self,
*,
AutoScalingGroupName: str,
ForceDelete: bool = ...,
) -> Dict[str, Any]:
...# delete_warm_pool method usage example with argument unpacking
kwargs: DeleteWarmPoolTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.delete_warm_pool(**kwargs)describe_account_limits#
Describes the current Amazon EC2 Auto Scaling resource quotas for your account.
Type annotations and code completion for boto3.client("autoscaling").describe_account_limits method.
boto3 documentation
# describe_account_limits method definition
def describe_account_limits(
self,
) -> DescribeAccountLimitsAnswerTypeDef: # (1)
...describe_adjustment_types#
Describes the available adjustment types for step scaling and simple scaling policies.
Type annotations and code completion for boto3.client("autoscaling").describe_adjustment_types method.
boto3 documentation
# describe_adjustment_types method definition
def describe_adjustment_types(
self,
) -> DescribeAdjustmentTypesAnswerTypeDef: # (1)
...describe_auto_scaling_groups#
Gets information about the Auto Scaling groups in the account and Region.
Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_groups method.
boto3 documentation
# describe_auto_scaling_groups method definition
def describe_auto_scaling_groups(
self,
*,
AutoScalingGroupNames: Sequence[str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
Filters: Sequence[FilterTypeDef] = ..., # (1)
) -> AutoScalingGroupsTypeTypeDef: # (2)
...# describe_auto_scaling_groups method usage example with argument unpacking
kwargs: AutoScalingGroupNamesTypeRequestTypeDef = { # (1)
"AutoScalingGroupNames": ...,
}
parent.describe_auto_scaling_groups(**kwargs)describe_auto_scaling_instances#
Gets information about the Auto Scaling instances in the account and Region.
Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_instances method.
boto3 documentation
# describe_auto_scaling_instances method definition
def describe_auto_scaling_instances(
self,
*,
InstanceIds: Sequence[str] = ...,
MaxRecords: int = ...,
NextToken: str = ...,
) -> AutoScalingInstancesTypeTypeDef: # (1)
...# describe_auto_scaling_instances method usage example with argument unpacking
kwargs: DescribeAutoScalingInstancesTypeRequestTypeDef = { # (1)
"InstanceIds": ...,
}
parent.describe_auto_scaling_instances(**kwargs)describe_auto_scaling_notification_types#
Describes the notification types that are supported by Amazon EC2 Auto Scaling.
Type annotations and code completion for boto3.client("autoscaling").describe_auto_scaling_notification_types method.
boto3 documentation
# describe_auto_scaling_notification_types method definition
def describe_auto_scaling_notification_types(
self,
) -> DescribeAutoScalingNotificationTypesAnswerTypeDef: # (1)
...describe_instance_refreshes#
Gets information about the instance refreshes for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").describe_instance_refreshes method.
boto3 documentation
# describe_instance_refreshes method definition
def describe_instance_refreshes(
self,
*,
AutoScalingGroupName: str,
InstanceRefreshIds: Sequence[str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> DescribeInstanceRefreshesAnswerTypeDef: # (1)
...# describe_instance_refreshes method usage example with argument unpacking
kwargs: DescribeInstanceRefreshesTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_instance_refreshes(**kwargs)describe_launch_configurations#
Gets information about the launch configurations in the account and Region.
Type annotations and code completion for boto3.client("autoscaling").describe_launch_configurations method.
boto3 documentation
# describe_launch_configurations method definition
def describe_launch_configurations(
self,
*,
LaunchConfigurationNames: Sequence[str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> LaunchConfigurationsTypeTypeDef: # (1)
...# describe_launch_configurations method usage example with argument unpacking
kwargs: LaunchConfigurationNamesTypeRequestTypeDef = { # (1)
"LaunchConfigurationNames": ...,
}
parent.describe_launch_configurations(**kwargs)describe_lifecycle_hook_types#
Describes the available types of lifecycle hooks.
Type annotations and code completion for boto3.client("autoscaling").describe_lifecycle_hook_types method.
boto3 documentation
# describe_lifecycle_hook_types method definition
def describe_lifecycle_hook_types(
self,
) -> DescribeLifecycleHookTypesAnswerTypeDef: # (1)
...describe_lifecycle_hooks#
Gets information about the lifecycle hooks for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").describe_lifecycle_hooks method.
boto3 documentation
# describe_lifecycle_hooks method definition
def describe_lifecycle_hooks(
self,
*,
AutoScalingGroupName: str,
LifecycleHookNames: Sequence[str] = ...,
) -> DescribeLifecycleHooksAnswerTypeDef: # (1)
...# describe_lifecycle_hooks method usage example with argument unpacking
kwargs: DescribeLifecycleHooksTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_lifecycle_hooks(**kwargs)describe_load_balancer_target_groups#
.
Type annotations and code completion for boto3.client("autoscaling").describe_load_balancer_target_groups method.
boto3 documentation
# describe_load_balancer_target_groups method definition
def describe_load_balancer_target_groups(
self,
*,
AutoScalingGroupName: str,
NextToken: str = ...,
MaxRecords: int = ...,
) -> DescribeLoadBalancerTargetGroupsResponseTypeDef: # (1)
...# describe_load_balancer_target_groups method usage example with argument unpacking
kwargs: DescribeLoadBalancerTargetGroupsRequestRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_load_balancer_target_groups(**kwargs)describe_load_balancers#
.
Type annotations and code completion for boto3.client("autoscaling").describe_load_balancers method.
boto3 documentation
# describe_load_balancers method definition
def describe_load_balancers(
self,
*,
AutoScalingGroupName: str,
NextToken: str = ...,
MaxRecords: int = ...,
) -> DescribeLoadBalancersResponseTypeDef: # (1)
...# describe_load_balancers method usage example with argument unpacking
kwargs: DescribeLoadBalancersRequestRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_load_balancers(**kwargs)describe_metric_collection_types#
Describes the available CloudWatch metrics for Amazon EC2 Auto Scaling.
Type annotations and code completion for boto3.client("autoscaling").describe_metric_collection_types method.
boto3 documentation
# describe_metric_collection_types method definition
def describe_metric_collection_types(
self,
) -> DescribeMetricCollectionTypesAnswerTypeDef: # (1)
...describe_notification_configurations#
Gets information about the Amazon SNS notifications that are configured for one or more Auto Scaling groups.
Type annotations and code completion for boto3.client("autoscaling").describe_notification_configurations method.
boto3 documentation
# describe_notification_configurations method definition
def describe_notification_configurations(
self,
*,
AutoScalingGroupNames: Sequence[str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> DescribeNotificationConfigurationsAnswerTypeDef: # (1)
...# describe_notification_configurations method usage example with argument unpacking
kwargs: DescribeNotificationConfigurationsTypeRequestTypeDef = { # (1)
"AutoScalingGroupNames": ...,
}
parent.describe_notification_configurations(**kwargs)describe_policies#
Gets information about the scaling policies in the account and Region.
Type annotations and code completion for boto3.client("autoscaling").describe_policies method.
boto3 documentation
# describe_policies method definition
def describe_policies(
self,
*,
AutoScalingGroupName: str = ...,
PolicyNames: Sequence[str] = ...,
PolicyTypes: Sequence[str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> PoliciesTypeTypeDef: # (1)
...# describe_policies method usage example with argument unpacking
kwargs: DescribePoliciesTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_policies(**kwargs)describe_scaling_activities#
Gets information about the scaling activities in the account and Region.
Type annotations and code completion for boto3.client("autoscaling").describe_scaling_activities method.
boto3 documentation
# describe_scaling_activities method definition
def describe_scaling_activities(
self,
*,
ActivityIds: Sequence[str] = ...,
AutoScalingGroupName: str = ...,
IncludeDeletedGroups: bool = ...,
MaxRecords: int = ...,
NextToken: str = ...,
) -> ActivitiesTypeTypeDef: # (1)
...# describe_scaling_activities method usage example with argument unpacking
kwargs: DescribeScalingActivitiesTypeRequestTypeDef = { # (1)
"ActivityIds": ...,
}
parent.describe_scaling_activities(**kwargs)describe_scaling_process_types#
Describes the scaling process types for use with the ResumeProcesses and SuspendProcesses APIs.
Type annotations and code completion for boto3.client("autoscaling").describe_scaling_process_types method.
boto3 documentation
# describe_scaling_process_types method definition
def describe_scaling_process_types(
self,
) -> ProcessesTypeTypeDef: # (1)
...describe_scheduled_actions#
Gets information about the scheduled actions that haven't run or that have not reached their end time.
Type annotations and code completion for boto3.client("autoscaling").describe_scheduled_actions method.
boto3 documentation
# describe_scheduled_actions method definition
def describe_scheduled_actions(
self,
*,
AutoScalingGroupName: str = ...,
ScheduledActionNames: Sequence[str] = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> ScheduledActionsTypeTypeDef: # (1)
...# describe_scheduled_actions method usage example with argument unpacking
kwargs: DescribeScheduledActionsTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_scheduled_actions(**kwargs)describe_tags#
Describes the specified tags.
Type annotations and code completion for boto3.client("autoscaling").describe_tags method.
boto3 documentation
# describe_tags method definition
def describe_tags(
self,
*,
Filters: Sequence[FilterTypeDef] = ..., # (1)
NextToken: str = ...,
MaxRecords: int = ...,
) -> TagsTypeTypeDef: # (2)
...- See FilterTypeDef
- See TagsTypeTypeDef
# describe_tags method usage example with argument unpacking
kwargs: DescribeTagsTypeRequestTypeDef = { # (1)
"Filters": ...,
}
parent.describe_tags(**kwargs)describe_termination_policy_types#
Describes the termination policies supported by Amazon EC2 Auto Scaling.
Type annotations and code completion for boto3.client("autoscaling").describe_termination_policy_types method.
boto3 documentation
# describe_termination_policy_types method definition
def describe_termination_policy_types(
self,
) -> DescribeTerminationPolicyTypesAnswerTypeDef: # (1)
...describe_traffic_sources#
Gets information about the traffic sources for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").describe_traffic_sources method.
boto3 documentation
# describe_traffic_sources method definition
def describe_traffic_sources(
self,
*,
AutoScalingGroupName: str,
TrafficSourceType: str = ...,
NextToken: str = ...,
MaxRecords: int = ...,
) -> DescribeTrafficSourcesResponseTypeDef: # (1)
...# describe_traffic_sources method usage example with argument unpacking
kwargs: DescribeTrafficSourcesRequestRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_traffic_sources(**kwargs)describe_warm_pool#
Gets information about a warm pool and its instances.
Type annotations and code completion for boto3.client("autoscaling").describe_warm_pool method.
boto3 documentation
# describe_warm_pool method definition
def describe_warm_pool(
self,
*,
AutoScalingGroupName: str,
MaxRecords: int = ...,
NextToken: str = ...,
) -> DescribeWarmPoolAnswerTypeDef: # (1)
...# describe_warm_pool method usage example with argument unpacking
kwargs: DescribeWarmPoolTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.describe_warm_pool(**kwargs)detach_instances#
Removes one or more instances from the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").detach_instances method.
boto3 documentation
# detach_instances method definition
def detach_instances(
self,
*,
AutoScalingGroupName: str,
ShouldDecrementDesiredCapacity: bool,
InstanceIds: Sequence[str] = ...,
) -> DetachInstancesAnswerTypeDef: # (1)
...# detach_instances method usage example with argument unpacking
kwargs: DetachInstancesQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ShouldDecrementDesiredCapacity": ...,
}
parent.detach_instances(**kwargs)detach_load_balancer_target_groups#
.
Type annotations and code completion for boto3.client("autoscaling").detach_load_balancer_target_groups method.
boto3 documentation
# detach_load_balancer_target_groups method definition
def detach_load_balancer_target_groups(
self,
*,
AutoScalingGroupName: str,
TargetGroupARNs: Sequence[str],
) -> Dict[str, Any]:
...# detach_load_balancer_target_groups method usage example with argument unpacking
kwargs: DetachLoadBalancerTargetGroupsTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TargetGroupARNs": ...,
}
parent.detach_load_balancer_target_groups(**kwargs)detach_load_balancers#
.
Type annotations and code completion for boto3.client("autoscaling").detach_load_balancers method.
boto3 documentation
# detach_load_balancers method definition
def detach_load_balancers(
self,
*,
AutoScalingGroupName: str,
LoadBalancerNames: Sequence[str],
) -> Dict[str, Any]:
...# detach_load_balancers method usage example with argument unpacking
kwargs: DetachLoadBalancersTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"LoadBalancerNames": ...,
}
parent.detach_load_balancers(**kwargs)detach_traffic_sources#
Detaches one or more traffic sources from the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").detach_traffic_sources method.
boto3 documentation
# detach_traffic_sources method definition
def detach_traffic_sources(
self,
*,
AutoScalingGroupName: str,
TrafficSources: Sequence[TrafficSourceIdentifierTypeDef], # (1)
) -> Dict[str, Any]:
...# detach_traffic_sources method usage example with argument unpacking
kwargs: DetachTrafficSourcesTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TrafficSources": ...,
}
parent.detach_traffic_sources(**kwargs)disable_metrics_collection#
Disables group metrics collection for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").disable_metrics_collection method.
boto3 documentation
# disable_metrics_collection method definition
def disable_metrics_collection(
self,
*,
AutoScalingGroupName: str,
Metrics: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# disable_metrics_collection method usage example with argument unpacking
kwargs: DisableMetricsCollectionQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.disable_metrics_collection(**kwargs)enable_metrics_collection#
Enables group metrics collection for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").enable_metrics_collection method.
boto3 documentation
# enable_metrics_collection method definition
def enable_metrics_collection(
self,
*,
AutoScalingGroupName: str,
Granularity: str,
Metrics: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# enable_metrics_collection method usage example with argument unpacking
kwargs: EnableMetricsCollectionQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"Granularity": ...,
}
parent.enable_metrics_collection(**kwargs)enter_standby#
Moves the specified instances into the standby state.
Type annotations and code completion for boto3.client("autoscaling").enter_standby method.
boto3 documentation
# enter_standby method definition
def enter_standby(
self,
*,
AutoScalingGroupName: str,
ShouldDecrementDesiredCapacity: bool,
InstanceIds: Sequence[str] = ...,
) -> EnterStandbyAnswerTypeDef: # (1)
...# enter_standby method usage example with argument unpacking
kwargs: EnterStandbyQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ShouldDecrementDesiredCapacity": ...,
}
parent.enter_standby(**kwargs)execute_policy#
Executes the specified policy.
Type annotations and code completion for boto3.client("autoscaling").execute_policy method.
boto3 documentation
# execute_policy method definition
def execute_policy(
self,
*,
PolicyName: str,
AutoScalingGroupName: str = ...,
HonorCooldown: bool = ...,
MetricValue: float = ...,
BreachThreshold: float = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# execute_policy method usage example with argument unpacking
kwargs: ExecutePolicyTypeRequestTypeDef = { # (1)
"PolicyName": ...,
}
parent.execute_policy(**kwargs)exit_standby#
Moves the specified instances out of the standby state.
Type annotations and code completion for boto3.client("autoscaling").exit_standby method.
boto3 documentation
# exit_standby method definition
def exit_standby(
self,
*,
AutoScalingGroupName: str,
InstanceIds: Sequence[str] = ...,
) -> ExitStandbyAnswerTypeDef: # (1)
...# exit_standby method usage example with argument unpacking
kwargs: ExitStandbyQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.exit_standby(**kwargs)generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("autoscaling").generate_presigned_url method.
boto3 documentation
# generate_presigned_url method definition
def generate_presigned_url(
self,
ClientMethod: str,
Params: Mapping[str, Any] = ...,
ExpiresIn: int = 3600,
HttpMethod: str = ...,
) -> str:
...get_predictive_scaling_forecast#
Retrieves the forecast data for a predictive scaling policy.
Type annotations and code completion for boto3.client("autoscaling").get_predictive_scaling_forecast method.
boto3 documentation
# get_predictive_scaling_forecast method definition
def get_predictive_scaling_forecast(
self,
*,
AutoScalingGroupName: str,
PolicyName: str,
StartTime: Union[datetime, str],
EndTime: Union[datetime, str],
) -> GetPredictiveScalingForecastAnswerTypeDef: # (1)
...# get_predictive_scaling_forecast method usage example with argument unpacking
kwargs: GetPredictiveScalingForecastTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"PolicyName": ...,
"StartTime": ...,
"EndTime": ...,
}
parent.get_predictive_scaling_forecast(**kwargs)put_lifecycle_hook#
Creates or updates a lifecycle hook for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").put_lifecycle_hook method.
boto3 documentation
# put_lifecycle_hook method definition
def put_lifecycle_hook(
self,
*,
LifecycleHookName: str,
AutoScalingGroupName: str,
LifecycleTransition: str = ...,
RoleARN: str = ...,
NotificationTargetARN: str = ...,
NotificationMetadata: str = ...,
HeartbeatTimeout: int = ...,
DefaultResult: str = ...,
) -> Dict[str, Any]:
...# put_lifecycle_hook method usage example with argument unpacking
kwargs: PutLifecycleHookTypeRequestTypeDef = { # (1)
"LifecycleHookName": ...,
"AutoScalingGroupName": ...,
}
parent.put_lifecycle_hook(**kwargs)put_notification_configuration#
Configures an Auto Scaling group to send notifications when specified events take place.
Type annotations and code completion for boto3.client("autoscaling").put_notification_configuration method.
boto3 documentation
# put_notification_configuration method definition
def put_notification_configuration(
self,
*,
AutoScalingGroupName: str,
TopicARN: str,
NotificationTypes: Sequence[str],
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_notification_configuration method usage example with argument unpacking
kwargs: PutNotificationConfigurationTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"TopicARN": ...,
"NotificationTypes": ...,
}
parent.put_notification_configuration(**kwargs)put_scaling_policy#
Creates or updates a scaling policy for an Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").put_scaling_policy method.
boto3 documentation
# put_scaling_policy method definition
def put_scaling_policy(
self,
*,
AutoScalingGroupName: str,
PolicyName: str,
PolicyType: str = ...,
AdjustmentType: str = ...,
MinAdjustmentStep: int = ...,
MinAdjustmentMagnitude: int = ...,
ScalingAdjustment: int = ...,
Cooldown: int = ...,
MetricAggregationType: str = ...,
StepAdjustments: Sequence[StepAdjustmentTypeDef] = ..., # (1)
EstimatedInstanceWarmup: int = ...,
TargetTrackingConfiguration: TargetTrackingConfigurationTypeDef = ..., # (2)
Enabled: bool = ...,
PredictiveScalingConfiguration: PredictiveScalingConfigurationTypeDef = ..., # (3)
) -> PolicyARNTypeTypeDef: # (4)
...- See StepAdjustmentTypeDef
- See TargetTrackingConfigurationTypeDef
- See PredictiveScalingConfigurationTypeDef
- See PolicyARNTypeTypeDef
# put_scaling_policy method usage example with argument unpacking
kwargs: PutScalingPolicyTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"PolicyName": ...,
}
parent.put_scaling_policy(**kwargs)put_scheduled_update_group_action#
Creates or updates a scheduled scaling action for an Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").put_scheduled_update_group_action method.
boto3 documentation
# put_scheduled_update_group_action method definition
def put_scheduled_update_group_action(
self,
*,
AutoScalingGroupName: str,
ScheduledActionName: str,
Time: Union[datetime, str] = ...,
StartTime: Union[datetime, str] = ...,
EndTime: Union[datetime, str] = ...,
Recurrence: str = ...,
MinSize: int = ...,
MaxSize: int = ...,
DesiredCapacity: int = ...,
TimeZone: str = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# put_scheduled_update_group_action method usage example with argument unpacking
kwargs: PutScheduledUpdateGroupActionTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"ScheduledActionName": ...,
}
parent.put_scheduled_update_group_action(**kwargs)put_warm_pool#
Creates or updates a warm pool for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").put_warm_pool method.
boto3 documentation
# put_warm_pool method definition
def put_warm_pool(
self,
*,
AutoScalingGroupName: str,
MaxGroupPreparedCapacity: int = ...,
MinSize: int = ...,
PoolState: WarmPoolStateType = ..., # (1)
InstanceReusePolicy: InstanceReusePolicyTypeDef = ..., # (2)
) -> Dict[str, Any]:
...# put_warm_pool method usage example with argument unpacking
kwargs: PutWarmPoolTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.put_warm_pool(**kwargs)record_lifecycle_action_heartbeat#
Records a heartbeat for the lifecycle action associated with the specified token or instance.
Type annotations and code completion for boto3.client("autoscaling").record_lifecycle_action_heartbeat method.
boto3 documentation
# record_lifecycle_action_heartbeat method definition
def record_lifecycle_action_heartbeat(
self,
*,
LifecycleHookName: str,
AutoScalingGroupName: str,
LifecycleActionToken: str = ...,
InstanceId: str = ...,
) -> Dict[str, Any]:
...# record_lifecycle_action_heartbeat method usage example with argument unpacking
kwargs: RecordLifecycleActionHeartbeatTypeRequestTypeDef = { # (1)
"LifecycleHookName": ...,
"AutoScalingGroupName": ...,
}
parent.record_lifecycle_action_heartbeat(**kwargs)resume_processes#
Resumes the specified suspended auto scaling processes, or all suspended process, for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").resume_processes method.
boto3 documentation
# resume_processes method definition
def resume_processes(
self,
*,
AutoScalingGroupName: str,
ScalingProcesses: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# resume_processes method usage example with argument unpacking
kwargs: ScalingProcessQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.resume_processes(**kwargs)rollback_instance_refresh#
Cancels an instance refresh that is in progress and rolls back any changes that it made.
Type annotations and code completion for boto3.client("autoscaling").rollback_instance_refresh method.
boto3 documentation
# rollback_instance_refresh method definition
def rollback_instance_refresh(
self,
*,
AutoScalingGroupName: str = ...,
) -> RollbackInstanceRefreshAnswerTypeDef: # (1)
...# rollback_instance_refresh method usage example with argument unpacking
kwargs: RollbackInstanceRefreshTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.rollback_instance_refresh(**kwargs)set_desired_capacity#
Sets the size of the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").set_desired_capacity method.
boto3 documentation
# set_desired_capacity method definition
def set_desired_capacity(
self,
*,
AutoScalingGroupName: str,
DesiredCapacity: int,
HonorCooldown: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# set_desired_capacity method usage example with argument unpacking
kwargs: SetDesiredCapacityTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
"DesiredCapacity": ...,
}
parent.set_desired_capacity(**kwargs)set_instance_health#
Sets the health status of the specified instance.
Type annotations and code completion for boto3.client("autoscaling").set_instance_health method.
boto3 documentation
# set_instance_health method definition
def set_instance_health(
self,
*,
InstanceId: str,
HealthStatus: str,
ShouldRespectGracePeriod: bool = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# set_instance_health method usage example with argument unpacking
kwargs: SetInstanceHealthQueryRequestTypeDef = { # (1)
"InstanceId": ...,
"HealthStatus": ...,
}
parent.set_instance_health(**kwargs)set_instance_protection#
Updates the instance protection settings of the specified instances.
Type annotations and code completion for boto3.client("autoscaling").set_instance_protection method.
boto3 documentation
# set_instance_protection method definition
def set_instance_protection(
self,
*,
InstanceIds: Sequence[str],
AutoScalingGroupName: str,
ProtectedFromScaleIn: bool,
) -> Dict[str, Any]:
...# set_instance_protection method usage example with argument unpacking
kwargs: SetInstanceProtectionQueryRequestTypeDef = { # (1)
"InstanceIds": ...,
"AutoScalingGroupName": ...,
"ProtectedFromScaleIn": ...,
}
parent.set_instance_protection(**kwargs)start_instance_refresh#
Starts an instance refresh.
Type annotations and code completion for boto3.client("autoscaling").start_instance_refresh method.
boto3 documentation
# start_instance_refresh method definition
def start_instance_refresh(
self,
*,
AutoScalingGroupName: str,
Strategy: RefreshStrategyType = ..., # (1)
DesiredConfiguration: DesiredConfigurationTypeDef = ..., # (2)
Preferences: RefreshPreferencesTypeDef = ..., # (3)
) -> StartInstanceRefreshAnswerTypeDef: # (4)
...- See RefreshStrategyType
- See DesiredConfigurationTypeDef
- See RefreshPreferencesTypeDef
- See StartInstanceRefreshAnswerTypeDef
# start_instance_refresh method usage example with argument unpacking
kwargs: StartInstanceRefreshTypeRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.start_instance_refresh(**kwargs)suspend_processes#
Suspends the specified auto scaling processes, or all processes, for the specified Auto Scaling group.
Type annotations and code completion for boto3.client("autoscaling").suspend_processes method.
boto3 documentation
# suspend_processes method definition
def suspend_processes(
self,
*,
AutoScalingGroupName: str,
ScalingProcesses: Sequence[str] = ...,
) -> EmptyResponseMetadataTypeDef: # (1)
...# suspend_processes method usage example with argument unpacking
kwargs: ScalingProcessQueryRequestTypeDef = { # (1)
"AutoScalingGroupName": ...,
}
parent.suspend_processes(**kwargs)terminate_instance_in_auto_scaling_group#
Terminates the specified instance and optionally adjusts the desired group size.
Type annotations and code completion for boto3.client("autoscaling").terminate_instance_in_auto_scaling_group method.