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

can_paginate

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:
    ...

generate_presigned_url

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:
    ...

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)
    ...

1. See EmptyResponseMetadataTypeDef

# attach_instances method usage example with argument unpacking

kwargs: AttachInstancesQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.attach_instances(**kwargs)

1. See AttachInstancesQueryTypeDef

attach_load_balancer_target_groups

This API operation is superseded by AttachTrafficSources, which can attach multiple traffic sources types.

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: AttachLoadBalancerTargetGroupsTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TargetGroupARNs": ...,
}

parent.attach_load_balancer_target_groups(**kwargs)

1. See AttachLoadBalancerTargetGroupsTypeTypeDef

attach_load_balancers

This API operation is superseded by https://docs.aws.amazon.com/autoscaling/ec2/APIReference/API_AttachTrafficSources.html, which can attach multiple traffic sources types.

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: AttachLoadBalancersTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "LoadBalancerNames": ...,
}

parent.attach_load_balancers(**kwargs)

1. See AttachLoadBalancersTypeTypeDef

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)
    SkipZonalShiftValidation: bool = ...,
) -> Dict[str, Any]:
    ...

1. See Sequence[TrafficSourceIdentifierTypeDef]

# attach_traffic_sources method usage example with argument unpacking

kwargs: AttachTrafficSourcesTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TrafficSources": ...,
}

parent.attach_traffic_sources(**kwargs)

1. See AttachTrafficSourcesTypeTypeDef

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)
    ...

1. See BatchDeleteScheduledActionAnswerTypeDef

# batch_delete_scheduled_action method usage example with argument unpacking

kwargs: BatchDeleteScheduledActionTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionNames": ...,
}

parent.batch_delete_scheduled_action(**kwargs)

1. See BatchDeleteScheduledActionTypeTypeDef

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)
    ...

1. See Sequence[ScheduledUpdateGroupActionRequestTypeDef]
2. See BatchPutScheduledUpdateGroupActionAnswerTypeDef

# batch_put_scheduled_update_group_action method usage example with argument unpacking

kwargs: BatchPutScheduledUpdateGroupActionTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledUpdateGroupActions": ...,
}

parent.batch_put_scheduled_update_group_action(**kwargs)

1. See BatchPutScheduledUpdateGroupActionTypeTypeDef

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)
    ...

1. See CancelInstanceRefreshAnswerTypeDef

# cancel_instance_refresh method usage example with argument unpacking

kwargs: CancelInstanceRefreshTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.cancel_instance_refresh(**kwargs)

1. See CancelInstanceRefreshTypeTypeDef

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: CompleteLifecycleActionTypeTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
    "LifecycleActionResult": ...,
}

parent.complete_lifecycle_action(**kwargs)

1. See CompleteLifecycleActionTypeTypeDef

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..

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: MixedInstancesPolicyUnionTypeDef = ...,  # (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)
    InstanceMaintenancePolicy: InstanceMaintenancePolicyTypeDef = ...,  # (6)
    AvailabilityZoneDistribution: AvailabilityZoneDistributionTypeDef = ...,  # (7)
    AvailabilityZoneImpairmentPolicy: AvailabilityZoneImpairmentPolicyTypeDef = ...,  # (8)
    SkipZonalShiftValidation: bool = ...,
    CapacityReservationSpecification: CapacityReservationSpecificationUnionTypeDef = ...,  # (9)
) -> EmptyResponseMetadataTypeDef:  # (10)
    ...

1. See LaunchTemplateSpecificationTypeDef
2. See MixedInstancesPolicyUnionTypeDef
3. See Sequence[LifecycleHookSpecificationTypeDef]
4. See Sequence[TagTypeDef]
5. See Sequence[TrafficSourceIdentifierTypeDef]
6. See InstanceMaintenancePolicyTypeDef
7. See AvailabilityZoneDistributionTypeDef
8. See AvailabilityZoneImpairmentPolicyTypeDef
9. See CapacityReservationSpecificationUnionTypeDef
10. See EmptyResponseMetadataTypeDef

# create_auto_scaling_group method usage example with argument unpacking

kwargs: CreateAutoScalingGroupTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "MinSize": ...,
    "MaxSize": ...,
}

parent.create_auto_scaling_group(**kwargs)

1. See CreateAutoScalingGroupTypeTypeDef

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)
    ...

1. See Sequence[BlockDeviceMappingTypeDef]
2. See InstanceMonitoringTypeDef
3. See InstanceMetadataOptionsTypeDef
4. See EmptyResponseMetadataTypeDef

# create_launch_configuration method usage example with argument unpacking

kwargs: CreateLaunchConfigurationTypeTypeDef = {  # (1)
    "LaunchConfigurationName": ...,
}

parent.create_launch_configuration(**kwargs)

1. See CreateLaunchConfigurationTypeTypeDef

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)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# create_or_update_tags method usage example with argument unpacking

kwargs: CreateOrUpdateTagsTypeTypeDef = {  # (1)
    "Tags": ...,
}

parent.create_or_update_tags(**kwargs)

1. See CreateOrUpdateTagsTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_auto_scaling_group method usage example with argument unpacking

kwargs: DeleteAutoScalingGroupTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.delete_auto_scaling_group(**kwargs)

1. See DeleteAutoScalingGroupTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_launch_configuration method usage example with argument unpacking

kwargs: LaunchConfigurationNameTypeTypeDef = {  # (1)
    "LaunchConfigurationName": ...,
}

parent.delete_launch_configuration(**kwargs)

1. See LaunchConfigurationNameTypeTypeDef

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: DeleteLifecycleHookTypeTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
}

parent.delete_lifecycle_hook(**kwargs)

1. See DeleteLifecycleHookTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_notification_configuration method usage example with argument unpacking

kwargs: DeleteNotificationConfigurationTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TopicARN": ...,
}

parent.delete_notification_configuration(**kwargs)

1. See DeleteNotificationConfigurationTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_policy method usage example with argument unpacking

kwargs: DeletePolicyTypeTypeDef = {  # (1)
    "PolicyName": ...,
}

parent.delete_policy(**kwargs)

1. See DeletePolicyTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_scheduled_action method usage example with argument unpacking

kwargs: DeleteScheduledActionTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionName": ...,
}

parent.delete_scheduled_action(**kwargs)

1. See DeleteScheduledActionTypeTypeDef

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)
    ...

1. See Sequence[TagTypeDef]
2. See EmptyResponseMetadataTypeDef

# delete_tags method usage example with argument unpacking

kwargs: DeleteTagsTypeTypeDef = {  # (1)
    "Tags": ...,
}

parent.delete_tags(**kwargs)

1. See DeleteTagsTypeTypeDef

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: DeleteWarmPoolTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.delete_warm_pool(**kwargs)

1. See DeleteWarmPoolTypeTypeDef

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)
    ...

1. See DescribeAccountLimitsAnswerTypeDef

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)
    ...

1. See DescribeAdjustmentTypesAnswerTypeDef

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)
    ...

1. See Sequence[FilterTypeDef]
2. See AutoScalingGroupsTypeTypeDef

# describe_auto_scaling_groups method usage example with argument unpacking

kwargs: AutoScalingGroupNamesTypeTypeDef = {  # (1)
    "AutoScalingGroupNames": ...,
}

parent.describe_auto_scaling_groups(**kwargs)

1. See AutoScalingGroupNamesTypeTypeDef

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)
    ...

1. See AutoScalingInstancesTypeTypeDef

# describe_auto_scaling_instances method usage example with argument unpacking

kwargs: DescribeAutoScalingInstancesTypeTypeDef = {  # (1)
    "InstanceIds": ...,
}

parent.describe_auto_scaling_instances(**kwargs)

1. See DescribeAutoScalingInstancesTypeTypeDef

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)
    ...

1. See DescribeAutoScalingNotificationTypesAnswerTypeDef

describe_instance_refreshes

Gets information about the instance refreshes for the specified Auto Scaling group from the previous six weeks.

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)
    ...

1. See DescribeInstanceRefreshesAnswerTypeDef

# describe_instance_refreshes method usage example with argument unpacking

kwargs: DescribeInstanceRefreshesTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_instance_refreshes(**kwargs)

1. See DescribeInstanceRefreshesTypeTypeDef

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)
    ...

1. See LaunchConfigurationsTypeTypeDef

# describe_launch_configurations method usage example with argument unpacking

kwargs: LaunchConfigurationNamesTypeTypeDef = {  # (1)
    "LaunchConfigurationNames": ...,
}

parent.describe_launch_configurations(**kwargs)

1. See LaunchConfigurationNamesTypeTypeDef

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)
    ...

1. See DescribeLifecycleHookTypesAnswerTypeDef

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)
    ...

1. See DescribeLifecycleHooksAnswerTypeDef

# describe_lifecycle_hooks method usage example with argument unpacking

kwargs: DescribeLifecycleHooksTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_lifecycle_hooks(**kwargs)

1. See DescribeLifecycleHooksTypeTypeDef

describe_load_balancer_target_groups

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types.

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)
    ...

1. See DescribeLoadBalancerTargetGroupsResponseTypeDef

# describe_load_balancer_target_groups method usage example with argument unpacking

kwargs: DescribeLoadBalancerTargetGroupsRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_load_balancer_target_groups(**kwargs)

1. See DescribeLoadBalancerTargetGroupsRequestTypeDef

describe_load_balancers

This API operation is superseded by DescribeTrafficSources, which can describe multiple traffic sources types.

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)
    ...

1. See DescribeLoadBalancersResponseTypeDef

# describe_load_balancers method usage example with argument unpacking

kwargs: DescribeLoadBalancersRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_load_balancers(**kwargs)

1. See DescribeLoadBalancersRequestTypeDef

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)
    ...

1. See DescribeMetricCollectionTypesAnswerTypeDef

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)
    ...

1. See DescribeNotificationConfigurationsAnswerTypeDef

# describe_notification_configurations method usage example with argument unpacking

kwargs: DescribeNotificationConfigurationsTypeTypeDef = {  # (1)
    "AutoScalingGroupNames": ...,
}

parent.describe_notification_configurations(**kwargs)

1. See DescribeNotificationConfigurationsTypeTypeDef

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)
    ...

1. See PoliciesTypeTypeDef

# describe_policies method usage example with argument unpacking

kwargs: DescribePoliciesTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_policies(**kwargs)

1. See DescribePoliciesTypeTypeDef

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)
    ...

1. See ActivitiesTypeTypeDef

# describe_scaling_activities method usage example with argument unpacking

kwargs: DescribeScalingActivitiesTypeTypeDef = {  # (1)
    "ActivityIds": ...,
}

parent.describe_scaling_activities(**kwargs)

1. See DescribeScalingActivitiesTypeTypeDef

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)
    ...

1. See ProcessesTypeTypeDef

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: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    NextToken: str = ...,
    MaxRecords: int = ...,
) -> ScheduledActionsTypeTypeDef:  # (1)
    ...

1. See ScheduledActionsTypeTypeDef

# describe_scheduled_actions method usage example with argument unpacking

kwargs: DescribeScheduledActionsTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_scheduled_actions(**kwargs)

1. See DescribeScheduledActionsTypeTypeDef

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)
    ...

1. See Sequence[FilterTypeDef]
2. See TagsTypeTypeDef

# describe_tags method usage example with argument unpacking

kwargs: DescribeTagsTypeTypeDef = {  # (1)
    "Filters": ...,
}

parent.describe_tags(**kwargs)

1. See DescribeTagsTypeTypeDef

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)
    ...

1. See DescribeTerminationPolicyTypesAnswerTypeDef

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)
    ...

1. See DescribeTrafficSourcesResponseTypeDef

# describe_traffic_sources method usage example with argument unpacking

kwargs: DescribeTrafficSourcesRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_traffic_sources(**kwargs)

1. See DescribeTrafficSourcesRequestTypeDef

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)
    ...

1. See DescribeWarmPoolAnswerTypeDef

# describe_warm_pool method usage example with argument unpacking

kwargs: DescribeWarmPoolTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.describe_warm_pool(**kwargs)

1. See DescribeWarmPoolTypeTypeDef

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)
    ...

1. See DetachInstancesAnswerTypeDef

# detach_instances method usage example with argument unpacking

kwargs: DetachInstancesQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ShouldDecrementDesiredCapacity": ...,
}

parent.detach_instances(**kwargs)

1. See DetachInstancesQueryTypeDef

detach_load_balancer_target_groups

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types.

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: DetachLoadBalancerTargetGroupsTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TargetGroupARNs": ...,
}

parent.detach_load_balancer_target_groups(**kwargs)

1. See DetachLoadBalancerTargetGroupsTypeTypeDef

detach_load_balancers

This API operation is superseded by DetachTrafficSources, which can detach multiple traffic sources types.

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: DetachLoadBalancersTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "LoadBalancerNames": ...,
}

parent.detach_load_balancers(**kwargs)

1. See DetachLoadBalancersTypeTypeDef

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]:
    ...

1. See Sequence[TrafficSourceIdentifierTypeDef]

# detach_traffic_sources method usage example with argument unpacking

kwargs: DetachTrafficSourcesTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TrafficSources": ...,
}

parent.detach_traffic_sources(**kwargs)

1. See DetachTrafficSourcesTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# disable_metrics_collection method usage example with argument unpacking

kwargs: DisableMetricsCollectionQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.disable_metrics_collection(**kwargs)

1. See DisableMetricsCollectionQueryTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# enable_metrics_collection method usage example with argument unpacking

kwargs: EnableMetricsCollectionQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "Granularity": ...,
}

parent.enable_metrics_collection(**kwargs)

1. See EnableMetricsCollectionQueryTypeDef

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)
    ...

1. See EnterStandbyAnswerTypeDef

# enter_standby method usage example with argument unpacking

kwargs: EnterStandbyQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ShouldDecrementDesiredCapacity": ...,
}

parent.enter_standby(**kwargs)

1. See EnterStandbyQueryTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# execute_policy method usage example with argument unpacking

kwargs: ExecutePolicyTypeTypeDef = {  # (1)
    "PolicyName": ...,
}

parent.execute_policy(**kwargs)

1. See ExecutePolicyTypeTypeDef

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)
    ...

1. See ExitStandbyAnswerTypeDef

# exit_standby method usage example with argument unpacking

kwargs: ExitStandbyQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.exit_standby(**kwargs)

1. See ExitStandbyQueryTypeDef

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: TimestampTypeDef,
    EndTime: TimestampTypeDef,
) -> GetPredictiveScalingForecastAnswerTypeDef:  # (1)
    ...

1. See GetPredictiveScalingForecastAnswerTypeDef

# get_predictive_scaling_forecast method usage example with argument unpacking

kwargs: GetPredictiveScalingForecastTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "PolicyName": ...,
    "StartTime": ...,
    "EndTime": ...,
}

parent.get_predictive_scaling_forecast(**kwargs)

1. See GetPredictiveScalingForecastTypeTypeDef

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: PutLifecycleHookTypeTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
}

parent.put_lifecycle_hook(**kwargs)

1. See PutLifecycleHookTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# put_notification_configuration method usage example with argument unpacking

kwargs: PutNotificationConfigurationTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "TopicARN": ...,
    "NotificationTypes": ...,
}

parent.put_notification_configuration(**kwargs)

1. See PutNotificationConfigurationTypeTypeDef

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: TargetTrackingConfigurationUnionTypeDef = ...,  # (2)
    Enabled: bool = ...,
    PredictiveScalingConfiguration: PredictiveScalingConfigurationUnionTypeDef = ...,  # (3)
) -> PolicyARNTypeTypeDef:  # (4)
    ...

1. See Sequence[StepAdjustmentTypeDef]
2. See TargetTrackingConfigurationUnionTypeDef
3. See PredictiveScalingConfigurationUnionTypeDef
4. See PolicyARNTypeTypeDef

# put_scaling_policy method usage example with argument unpacking

kwargs: PutScalingPolicyTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "PolicyName": ...,
}

parent.put_scaling_policy(**kwargs)

1. See PutScalingPolicyTypeTypeDef

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: TimestampTypeDef = ...,
    StartTime: TimestampTypeDef = ...,
    EndTime: TimestampTypeDef = ...,
    Recurrence: str = ...,
    MinSize: int = ...,
    MaxSize: int = ...,
    DesiredCapacity: int = ...,
    TimeZone: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# put_scheduled_update_group_action method usage example with argument unpacking

kwargs: PutScheduledUpdateGroupActionTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "ScheduledActionName": ...,
}

parent.put_scheduled_update_group_action(**kwargs)

1. See PutScheduledUpdateGroupActionTypeTypeDef

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]:
    ...

1. See WarmPoolStateType
2. See InstanceReusePolicyTypeDef

# put_warm_pool method usage example with argument unpacking

kwargs: PutWarmPoolTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.put_warm_pool(**kwargs)

1. See PutWarmPoolTypeTypeDef

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: RecordLifecycleActionHeartbeatTypeTypeDef = {  # (1)
    "LifecycleHookName": ...,
    "AutoScalingGroupName": ...,
}

parent.record_lifecycle_action_heartbeat(**kwargs)

1. See RecordLifecycleActionHeartbeatTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# resume_processes method usage example with argument unpacking

kwargs: ScalingProcessQueryTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.resume_processes(**kwargs)

1. See ScalingProcessQueryTypeDef

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)
    ...

1. See RollbackInstanceRefreshAnswerTypeDef

# rollback_instance_refresh method usage example with argument unpacking

kwargs: RollbackInstanceRefreshTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.rollback_instance_refresh(**kwargs)

1. See RollbackInstanceRefreshTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# set_desired_capacity method usage example with argument unpacking

kwargs: SetDesiredCapacityTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
    "DesiredCapacity": ...,
}

parent.set_desired_capacity(**kwargs)

1. See SetDesiredCapacityTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# set_instance_health method usage example with argument unpacking

kwargs: SetInstanceHealthQueryTypeDef = {  # (1)
    "InstanceId": ...,
    "HealthStatus": ...,
}

parent.set_instance_health(**kwargs)

1. See SetInstanceHealthQueryTypeDef

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: SetInstanceProtectionQueryTypeDef = {  # (1)
    "InstanceIds": ...,
    "AutoScalingGroupName": ...,
    "ProtectedFromScaleIn": ...,
}

parent.set_instance_protection(**kwargs)

1. See SetInstanceProtectionQueryTypeDef

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: DesiredConfigurationUnionTypeDef = ...,  # (2)
    Preferences: RefreshPreferencesUnionTypeDef = ...,  # (3)
) -> StartInstanceRefreshAnswerTypeDef:  # (4)
    ...

1. See RefreshStrategyType
2. See DesiredConfigurationUnionTypeDef
3. See RefreshPreferencesUnionTypeDef
4. See StartInstanceRefreshAnswerTypeDef

# start_instance_refresh method usage example with argument unpacking

kwargs: StartInstanceRefreshTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.start_instance_refresh(**kwargs)

1. See StartInstanceRefreshTypeTypeDef

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)
    ...

1. See EmptyResponseMetadataTypeDef

# suspend_processes method usage example with argument unpacking

kwargs: ScalingProcessQueryRequestTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.suspend_processes(**kwargs)

1. See ScalingProcessQueryRequestTypeDef

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. boto3 documentation

# terminate_instance_in_auto_scaling_group method definition

def terminate_instance_in_auto_scaling_group(
    self,
    *,
    InstanceId: str,
    ShouldDecrementDesiredCapacity: bool,
) -> ActivityTypeTypeDef:  # (1)
    ...

1. See ActivityTypeTypeDef

# terminate_instance_in_auto_scaling_group method usage example with argument unpacking

kwargs: TerminateInstanceInAutoScalingGroupTypeTypeDef = {  # (1)
    "InstanceId": ...,
    "ShouldDecrementDesiredCapacity": ...,
}

parent.terminate_instance_in_auto_scaling_group(**kwargs)

1. See TerminateInstanceInAutoScalingGroupTypeTypeDef

update_auto_scaling_group

We strongly recommend that all Auto Scaling groups use launch templates to ensure full functionality for Amazon EC2 Auto Scaling and Amazon EC2..

Type annotations and code completion for boto3.client("autoscaling").update_auto_scaling_group method. boto3 documentation

# update_auto_scaling_group method definition

def update_auto_scaling_group(
    self,
    *,
    AutoScalingGroupName: str,
    LaunchConfigurationName: str = ...,
    LaunchTemplate: LaunchTemplateSpecificationTypeDef = ...,  # (1)
    MixedInstancesPolicy: MixedInstancesPolicyUnionTypeDef = ...,  # (2)
    MinSize: int = ...,
    MaxSize: int = ...,
    DesiredCapacity: int = ...,
    DefaultCooldown: int = ...,
    AvailabilityZones: Sequence[str] = ...,
    HealthCheckType: str = ...,
    HealthCheckGracePeriod: int = ...,
    PlacementGroup: str = ...,
    VPCZoneIdentifier: str = ...,
    TerminationPolicies: Sequence[str] = ...,
    NewInstancesProtectedFromScaleIn: bool = ...,
    ServiceLinkedRoleARN: str = ...,
    MaxInstanceLifetime: int = ...,
    CapacityRebalance: bool = ...,
    Context: str = ...,
    DesiredCapacityType: str = ...,
    DefaultInstanceWarmup: int = ...,
    InstanceMaintenancePolicy: InstanceMaintenancePolicyTypeDef = ...,  # (3)
    AvailabilityZoneDistribution: AvailabilityZoneDistributionTypeDef = ...,  # (4)
    AvailabilityZoneImpairmentPolicy: AvailabilityZoneImpairmentPolicyTypeDef = ...,  # (5)
    SkipZonalShiftValidation: bool = ...,
    CapacityReservationSpecification: CapacityReservationSpecificationUnionTypeDef = ...,  # (6)
) -> EmptyResponseMetadataTypeDef:  # (7)
    ...

1. See LaunchTemplateSpecificationTypeDef
2. See MixedInstancesPolicyUnionTypeDef
3. See InstanceMaintenancePolicyTypeDef
4. See AvailabilityZoneDistributionTypeDef
5. See AvailabilityZoneImpairmentPolicyTypeDef
6. See CapacityReservationSpecificationUnionTypeDef
7. See EmptyResponseMetadataTypeDef

# update_auto_scaling_group method usage example with argument unpacking

kwargs: UpdateAutoScalingGroupTypeTypeDef = {  # (1)
    "AutoScalingGroupName": ...,
}

parent.update_auto_scaling_group(**kwargs)

1. See UpdateAutoScalingGroupTypeTypeDef

get_paginator

Type annotations and code completion for boto3.client("autoscaling").get_paginator method with overloads.

• client.get_paginator("describe_auto_scaling_groups") -> DescribeAutoScalingGroupsPaginator
• client.get_paginator("describe_auto_scaling_instances") -> DescribeAutoScalingInstancesPaginator
• client.get_paginator("describe_launch_configurations") -> DescribeLaunchConfigurationsPaginator
• client.get_paginator("describe_load_balancer_target_groups") -> DescribeLoadBalancerTargetGroupsPaginator
• client.get_paginator("describe_load_balancers") -> DescribeLoadBalancersPaginator
• client.get_paginator("describe_notification_configurations") -> DescribeNotificationConfigurationsPaginator
• client.get_paginator("describe_policies") -> DescribePoliciesPaginator
• client.get_paginator("describe_scaling_activities") -> DescribeScalingActivitiesPaginator
• client.get_paginator("describe_scheduled_actions") -> DescribeScheduledActionsPaginator
• client.get_paginator("describe_tags") -> DescribeTagsPaginator
• client.get_paginator("describe_warm_pool") -> DescribeWarmPoolPaginator