Auto Scaling 2011-01-01

AttachInstances

$result = $client->attachInstances([/* ... */]);
$promise = $client->attachInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->attachInstances([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To attach an instance to an Auto Scaling group

This example attaches the specified instance to the specified Auto Scaling group.

$result = $client->attachInstances([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
]);

AttachLoadBalancerTargetGroups

$result = $client->attachLoadBalancerTargetGroups([/* ... */]);
$promise = $client->attachLoadBalancerTargetGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->attachLoadBalancerTargetGroups([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'TargetGroupARNs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To attach a target group to an Auto Scaling group

This example attaches the specified target group to the specified Auto Scaling group.

$result = $client->attachLoadBalancerTargetGroups([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'TargetGroupARNs' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
]);

AttachLoadBalancers

$result = $client->attachLoadBalancers([/* ... */]);
$promise = $client->attachLoadBalancersAsync([/* ... */]);

Parameter Syntax

$result = $client->attachLoadBalancers([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'LoadBalancerNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To attach a load balancer to an Auto Scaling group

This example attaches the specified load balancer to the specified Auto Scaling group.

$result = $client->attachLoadBalancers([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LoadBalancerNames' => [
        'my-load-balancer',
    ],
]);

CompleteLifecycleAction

$result = $client->completeLifecycleAction([/* ... */]);
$promise = $client->completeLifecycleActionAsync([/* ... */]);

Parameter Syntax

$result = $client->completeLifecycleAction([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
    'LifecycleActionResult' => '<string>', // REQUIRED
    'LifecycleActionToken' => '<string>',
    'LifecycleHookName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To complete the lifecycle action

This example notifies Auto Scaling that the specified lifecycle action is complete so that it can finish launching or terminating the instance.

$result = $client->completeLifecycleAction([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LifecycleActionResult' => 'CONTINUE',
    'LifecycleActionToken' => 'bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635',
    'LifecycleHookName' => 'my-lifecycle-hook',
]);

CreateAutoScalingGroup

$result = $client->createAutoScalingGroup([/* ... */]);
$promise = $client->createAutoScalingGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->createAutoScalingGroup([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'AvailabilityZones' => ['<string>', ...],
    'DefaultCooldown' => <integer>,
    'DesiredCapacity' => <integer>,
    'HealthCheckGracePeriod' => <integer>,
    'HealthCheckType' => '<string>',
    'InstanceId' => '<string>',
    'LaunchConfigurationName' => '<string>',
    'LaunchTemplate' => [
        'LaunchTemplateId' => '<string>',
        'LaunchTemplateName' => '<string>',
        'Version' => '<string>',
    ],
    'LifecycleHookSpecificationList' => [
        [
            'DefaultResult' => '<string>',
            'HeartbeatTimeout' => <integer>,
            'LifecycleHookName' => '<string>', // REQUIRED
            'LifecycleTransition' => '<string>', // REQUIRED
            'NotificationMetadata' => '<string>',
            'NotificationTargetARN' => '<string>',
            'RoleARN' => '<string>',
        ],
        // ...
    ],
    'LoadBalancerNames' => ['<string>', ...],
    'MaxSize' => <integer>, // REQUIRED
    'MinSize' => <integer>, // REQUIRED
    'NewInstancesProtectedFromScaleIn' => true || false,
    'PlacementGroup' => '<string>',
    'ServiceLinkedRoleARN' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>', // REQUIRED
            'PropagateAtLaunch' => true || false,
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
    'TargetGroupARNs' => ['<string>', ...],
    'TerminationPolicies' => ['<string>', ...],
    'VPCZoneIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• AlreadyExistsFault:

  You already have an Auto Scaling group or launch configuration with this name.

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To create an Auto Scaling group

This example creates an Auto Scaling group.

$result = $client->createAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LaunchConfigurationName' => 'my-launch-config',
    'MaxSize' => 3,
    'MinSize' => 1,
    'VPCZoneIdentifier' => 'subnet-4176792c',
]);

Example 2: To create an Auto Scaling group with an attached load balancer

This example creates an Auto Scaling group and attaches the specified Classic Load Balancer.

$result = $client->createAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'AvailabilityZones' => [
        'us-west-2c',
    ],
    'HealthCheckGracePeriod' => 120,
    'HealthCheckType' => 'ELB',
    'LaunchConfigurationName' => 'my-launch-config',
    'LoadBalancerNames' => [
        'my-load-balancer',
    ],
    'MaxSize' => 3,
    'MinSize' => 1,
]);

Example 3: To create an Auto Scaling group with an attached target group

This example creates an Auto Scaling group and attaches the specified target group.

$result = $client->createAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'HealthCheckGracePeriod' => 120,
    'HealthCheckType' => 'ELB',
    'LaunchConfigurationName' => 'my-launch-config',
    'MaxSize' => 3,
    'MinSize' => 1,
    'TargetGroupARNs' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
    'VPCZoneIdentifier' => 'subnet-4176792c, subnet-65ea5f08',
]);

CreateLaunchConfiguration

$result = $client->createLaunchConfiguration([/* ... */]);
$promise = $client->createLaunchConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->createLaunchConfiguration([
    'AssociatePublicIpAddress' => true || false,
    'BlockDeviceMappings' => [
        [
            'DeviceName' => '<string>', // REQUIRED
            'Ebs' => [
                'DeleteOnTermination' => true || false,
                'Encrypted' => true || false,
                'Iops' => <integer>,
                'SnapshotId' => '<string>',
                'VolumeSize' => <integer>,
                'VolumeType' => '<string>',
            ],
            'NoDevice' => true || false,
            'VirtualName' => '<string>',
        ],
        // ...
    ],
    'ClassicLinkVPCId' => '<string>',
    'ClassicLinkVPCSecurityGroups' => ['<string>', ...],
    'EbsOptimized' => true || false,
    'IamInstanceProfile' => '<string>',
    'ImageId' => '<string>',
    'InstanceId' => '<string>',
    'InstanceMonitoring' => [
        'Enabled' => true || false,
    ],
    'InstanceType' => '<string>',
    'KernelId' => '<string>',
    'KeyName' => '<string>',
    'LaunchConfigurationName' => '<string>', // REQUIRED
    'PlacementTenancy' => '<string>',
    'RamdiskId' => '<string>',
    'SecurityGroups' => ['<string>', ...],
    'SpotPrice' => '<string>',
    'UserData' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• AlreadyExistsFault:

  You already have an Auto Scaling group or launch configuration with this name.

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To create a launch configuration

This example creates a launch configuration.

$result = $client->createLaunchConfiguration([
    'IamInstanceProfile' => 'my-iam-role',
    'ImageId' => 'ami-12345678',
    'InstanceType' => 'm3.medium',
    'LaunchConfigurationName' => 'my-launch-config',
    'SecurityGroups' => [
        'sg-eb2af88e',
    ],
]);

CreateOrUpdateTags

$result = $client->createOrUpdateTags([/* ... */]);
$promise = $client->createOrUpdateTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->createOrUpdateTags([
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'PropagateAtLaunch' => true || false,
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• AlreadyExistsFault:

  You already have an Auto Scaling group or launch configuration with this name.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

Examples

Example 1: To create or update tags for an Auto Scaling group

This example adds two tags to the specified Auto Scaling group.

$result = $client->createOrUpdateTags([
    'Tags' => [
        [
            'Key' => 'Role',
            'PropagateAtLaunch' => 1,
            'ResourceId' => 'my-auto-scaling-group',
            'ResourceType' => 'auto-scaling-group',
            'Value' => 'WebServer',
        ],
        [
            'Key' => 'Dept',
            'PropagateAtLaunch' => 1,
            'ResourceId' => 'my-auto-scaling-group',
            'ResourceType' => 'auto-scaling-group',
            'Value' => 'Research',
        ],
    ],
]);

DeleteAutoScalingGroup

$result = $client->deleteAutoScalingGroup([/* ... */]);
$promise = $client->deleteAutoScalingGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteAutoScalingGroup([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'ForceDelete' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ScalingActivityInProgressFault:

  The operation can't be performed because there are scaling activities in progress.

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To delete an Auto Scaling group

This example deletes the specified Auto Scaling group.

$result = $client->deleteAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Example 2: To delete an Auto Scaling group and all its instances

This example deletes the specified Auto Scaling group and all its instances.

$result = $client->deleteAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'ForceDelete' => 1,
]);

DeleteLaunchConfiguration

$result = $client->deleteLaunchConfiguration([/* ... */]);
$promise = $client->deleteLaunchConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteLaunchConfiguration([
    'LaunchConfigurationName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To delete a launch configuration

This example deletes the specified launch configuration.

$result = $client->deleteLaunchConfiguration([
    'LaunchConfigurationName' => 'my-launch-config',
]);

DeleteLifecycleHook

$result = $client->deleteLifecycleHook([/* ... */]);
$promise = $client->deleteLifecycleHookAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteLifecycleHook([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'LifecycleHookName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To delete a lifecycle hook

This example deletes the specified lifecycle hook.

$result = $client->deleteLifecycleHook([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LifecycleHookName' => 'my-lifecycle-hook',
]);

DeleteNotificationConfiguration

$result = $client->deleteNotificationConfiguration([/* ... */]);
$promise = $client->deleteNotificationConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteNotificationConfiguration([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'TopicARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To delete an Auto Scaling notification

This example deletes the specified notification from the specified Auto Scaling group.

$result = $client->deleteNotificationConfiguration([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'TopicARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
]);

DeletePolicy

$result = $client->deletePolicy([/* ... */]);
$promise = $client->deletePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->deletePolicy([
    'AutoScalingGroupName' => '<string>',
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To delete an Auto Scaling policy

This example deletes the specified Auto Scaling policy.

$result = $client->deletePolicy([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'PolicyName' => 'ScaleIn',
]);

DeleteScheduledAction

$result = $client->deleteScheduledAction([/* ... */]);
$promise = $client->deleteScheduledActionAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteScheduledAction([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'ScheduledActionName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To delete a scheduled action from an Auto Scaling group

This example deletes the specified scheduled action from the specified Auto Scaling group.

$result = $client->deleteScheduledAction([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'ScheduledActionName' => 'my-scheduled-action',
]);

DeleteTags

$result = $client->deleteTags([/* ... */]);
$promise = $client->deleteTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteTags([
    'Tags' => [ // REQUIRED
        [
            'Key' => '<string>', // REQUIRED
            'PropagateAtLaunch' => true || false,
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

Examples

Example 1: To delete a tag from an Auto Scaling group

This example deletes the specified tag from the specified Auto Scaling group.

$result = $client->deleteTags([
    'Tags' => [
        [
            'Key' => 'Dept',
            'ResourceId' => 'my-auto-scaling-group',
            'ResourceType' => 'auto-scaling-group',
            'Value' => 'Research',
        ],
    ],
]);

DescribeAccountLimits

$result = $client->describeAccountLimits([/* ... */]);
$promise = $client->describeAccountLimitsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAccountLimits([
]);

Parameter Details

Result Syntax

[
    'MaxNumberOfAutoScalingGroups' => <integer>,
    'MaxNumberOfLaunchConfigurations' => <integer>,
    'NumberOfAutoScalingGroups' => <integer>,
    'NumberOfLaunchConfigurations' => <integer>,
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe your Auto Scaling account limits

This example describes the Auto Scaling limits for your AWS account.

$result = $client->describeAccountLimits([
]);

Result syntax:

[
    'MaxNumberOfAutoScalingGroups' => 20,
    'MaxNumberOfLaunchConfigurations' => 100,
    'NumberOfAutoScalingGroups' => 3,
    'NumberOfLaunchConfigurations' => 5,
]

DescribeAdjustmentTypes

$result = $client->describeAdjustmentTypes([/* ... */]);
$promise = $client->describeAdjustmentTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAdjustmentTypes([
]);

Parameter Details

Result Syntax

[
    'AdjustmentTypes' => [
        [
            'AdjustmentType' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the Auto Scaling adjustment types

This example describes the available adjustment types.

$result = $client->describeAdjustmentTypes([
]);

Result syntax:

[
    'AdjustmentTypes' => [
        [
            'AdjustmentType' => 'ChangeInCapacity',
        ],
        [
            'AdjustmentType' => 'ExactCapcity',
        ],
        [
            'AdjustmentType' => 'PercentChangeInCapacity',
        ],
    ],
]

DescribeAutoScalingGroups

$result = $client->describeAutoScalingGroups([/* ... */]);
$promise = $client->describeAutoScalingGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAutoScalingGroups([
    'AutoScalingGroupNames' => ['<string>', ...],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AutoScalingGroups' => [
        [
            'AutoScalingGroupARN' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'AvailabilityZones' => ['<string>', ...],
            'CreatedTime' => <DateTime>,
            'DefaultCooldown' => <integer>,
            'DesiredCapacity' => <integer>,
            'EnabledMetrics' => [
                [
                    'Granularity' => '<string>',
                    'Metric' => '<string>',
                ],
                // ...
            ],
            'HealthCheckGracePeriod' => <integer>,
            'HealthCheckType' => '<string>',
            'Instances' => [
                [
                    'AvailabilityZone' => '<string>',
                    'HealthStatus' => '<string>',
                    'InstanceId' => '<string>',
                    'LaunchConfigurationName' => '<string>',
                    'LaunchTemplate' => [
                        'LaunchTemplateId' => '<string>',
                        'LaunchTemplateName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'LifecycleState' => 'Pending|Pending:Wait|Pending:Proceed|Quarantined|InService|Terminating|Terminating:Wait|Terminating:Proceed|Terminated|Detaching|Detached|EnteringStandby|Standby',
                    'ProtectedFromScaleIn' => true || false,
                ],
                // ...
            ],
            'LaunchConfigurationName' => '<string>',
            'LaunchTemplate' => [
                'LaunchTemplateId' => '<string>',
                'LaunchTemplateName' => '<string>',
                'Version' => '<string>',
            ],
            'LoadBalancerNames' => ['<string>', ...],
            'MaxSize' => <integer>,
            'MinSize' => <integer>,
            'NewInstancesProtectedFromScaleIn' => true || false,
            'PlacementGroup' => '<string>',
            'ServiceLinkedRoleARN' => '<string>',
            'Status' => '<string>',
            'SuspendedProcesses' => [
                [
                    'ProcessName' => '<string>',
                    'SuspensionReason' => '<string>',
                ],
                // ...
            ],
            'Tags' => [
                [
                    'Key' => '<string>',
                    'PropagateAtLaunch' => true || false,
                    'ResourceId' => '<string>',
                    'ResourceType' => '<string>',
                    'Value' => '<string>',
                ],
                // ...
            ],
            'TargetGroupARNs' => ['<string>', ...],
            'TerminationPolicies' => ['<string>', ...],
            'VPCZoneIdentifier' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe an Auto Scaling group

This example describes the specified Auto Scaling group.

$result = $client->describeAutoScalingGroups([
    'AutoScalingGroupNames' => [
        'my-auto-scaling-group',
    ],
]);

Result syntax:

[
    'AutoScalingGroups' => [
        [
            'AutoScalingGroupARN' => 'arn:aws:autoscaling:us-west-2:123456789012:autoScalingGroup:930d940e-891e-4781-a11a-7b0acd480f03:autoScalingGroupName/my-auto-scaling-group',
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'AvailabilityZones' => [
                'us-west-2c',
            ],
            'CreatedTime' => ,
            'DefaultCooldown' => 300,
            'DesiredCapacity' => 1,
            'EnabledMetrics' => [
            ],
            'HealthCheckGracePeriod' => 300,
            'HealthCheckType' => 'EC2',
            'Instances' => [
                [
                    'AvailabilityZone' => 'us-west-2c',
                    'HealthStatus' => 'Healthy',
                    'InstanceId' => 'i-4ba0837f',
                    'LaunchConfigurationName' => 'my-launch-config',
                    'LifecycleState' => 'InService',
                    'ProtectedFromScaleIn' => ,
                ],
            ],
            'LaunchConfigurationName' => 'my-launch-config',
            'LoadBalancerNames' => [
            ],
            'MaxSize' => 1,
            'MinSize' => 0,
            'NewInstancesProtectedFromScaleIn' => ,
            'SuspendedProcesses' => [
            ],
            'Tags' => [
            ],
            'TerminationPolicies' => [
                'Default',
            ],
            'VPCZoneIdentifier' => 'subnet-12345678',
        ],
    ],
]

DescribeAutoScalingInstances

$result = $client->describeAutoScalingInstances([/* ... */]);
$promise = $client->describeAutoScalingInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAutoScalingInstances([
    'InstanceIds' => ['<string>', ...],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AutoScalingInstances' => [
        [
            'AutoScalingGroupName' => '<string>',
            'AvailabilityZone' => '<string>',
            'HealthStatus' => '<string>',
            'InstanceId' => '<string>',
            'LaunchConfigurationName' => '<string>',
            'LaunchTemplate' => [
                'LaunchTemplateId' => '<string>',
                'LaunchTemplateName' => '<string>',
                'Version' => '<string>',
            ],
            'LifecycleState' => '<string>',
            'ProtectedFromScaleIn' => true || false,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe one or more Auto Scaling instances

This example describes the specified Auto Scaling instance.

$result = $client->describeAutoScalingInstances([
    'InstanceIds' => [
        'i-4ba0837f',
    ],
]);

Result syntax:

[
    'AutoScalingInstances' => [
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'AvailabilityZone' => 'us-west-2c',
            'HealthStatus' => 'HEALTHY',
            'InstanceId' => 'i-4ba0837f',
            'LaunchConfigurationName' => 'my-launch-config',
            'LifecycleState' => 'InService',
            'ProtectedFromScaleIn' => ,
        ],
    ],
]

DescribeAutoScalingNotificationTypes

$result = $client->describeAutoScalingNotificationTypes([/* ... */]);
$promise = $client->describeAutoScalingNotificationTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeAutoScalingNotificationTypes([
]);

Parameter Details

Result Syntax

[
    'AutoScalingNotificationTypes' => ['<string>', ...],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the Auto Scaling notification types

This example describes the available notification types.

$result = $client->describeAutoScalingNotificationTypes([
]);

Result syntax:

[
    'AutoScalingNotificationTypes' => [
        'autoscaling:EC2_INSTANCE_LAUNCH',
        'autoscaling:EC2_INSTANCE_LAUNCH_ERROR',
        'autoscaling:EC2_INSTANCE_TERMINATE',
        'autoscaling:EC2_INSTANCE_TERMINATE_ERROR',
        'autoscaling:TEST_NOTIFICATION',
    ],
]

DescribeLaunchConfigurations

$result = $client->describeLaunchConfigurations([/* ... */]);
$promise = $client->describeLaunchConfigurationsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLaunchConfigurations([
    'LaunchConfigurationNames' => ['<string>', ...],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LaunchConfigurations' => [
        [
            'AssociatePublicIpAddress' => true || false,
            'BlockDeviceMappings' => [
                [
                    'DeviceName' => '<string>',
                    'Ebs' => [
                        'DeleteOnTermination' => true || false,
                        'Encrypted' => true || false,
                        'Iops' => <integer>,
                        'SnapshotId' => '<string>',
                        'VolumeSize' => <integer>,
                        'VolumeType' => '<string>',
                    ],
                    'NoDevice' => true || false,
                    'VirtualName' => '<string>',
                ],
                // ...
            ],
            'ClassicLinkVPCId' => '<string>',
            'ClassicLinkVPCSecurityGroups' => ['<string>', ...],
            'CreatedTime' => <DateTime>,
            'EbsOptimized' => true || false,
            'IamInstanceProfile' => '<string>',
            'ImageId' => '<string>',
            'InstanceMonitoring' => [
                'Enabled' => true || false,
            ],
            'InstanceType' => '<string>',
            'KernelId' => '<string>',
            'KeyName' => '<string>',
            'LaunchConfigurationARN' => '<string>',
            'LaunchConfigurationName' => '<string>',
            'PlacementTenancy' => '<string>',
            'RamdiskId' => '<string>',
            'SecurityGroups' => ['<string>', ...],
            'SpotPrice' => '<string>',
            'UserData' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe Auto Scaling launch configurations

This example describes the specified launch configuration.

$result = $client->describeLaunchConfigurations([
    'LaunchConfigurationNames' => [
        'my-launch-config',
    ],
]);

Result syntax:

[
    'LaunchConfigurations' => [
        [
            'AssociatePublicIpAddress' => 1,
            'BlockDeviceMappings' => [
            ],
            'CreatedTime' => ,
            'EbsOptimized' => ,
            'ImageId' => 'ami-043a5034',
            'InstanceMonitoring' => [
                'Enabled' => 1,
            ],
            'InstanceType' => 't1.micro',
            'LaunchConfigurationARN' => 'arn:aws:autoscaling:us-west-2:123456789012:launchConfiguration:98d3b196-4cf9-4e88-8ca1-8547c24ced8b:launchConfigurationName/my-launch-config',
            'LaunchConfigurationName' => 'my-launch-config',
            'SecurityGroups' => [
                'sg-67ef0308',
            ],
        ],
    ],
]

DescribeLifecycleHookTypes

$result = $client->describeLifecycleHookTypes([/* ... */]);
$promise = $client->describeLifecycleHookTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLifecycleHookTypes([
]);

Parameter Details

Result Syntax

[
    'LifecycleHookTypes' => ['<string>', ...],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the available types of lifecycle hooks

This example describes the available lifecycle hook types.

$result = $client->describeLifecycleHookTypes([
]);

Result syntax:

[
    'LifecycleHookTypes' => [
        'autoscaling:EC2_INSTANCE_LAUNCHING',
        'autoscaling:EC2_INSTANCE_TERMINATING',
    ],
]

DescribeLifecycleHooks

$result = $client->describeLifecycleHooks([/* ... */]);
$promise = $client->describeLifecycleHooksAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLifecycleHooks([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'LifecycleHookNames' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'LifecycleHooks' => [
        [
            'AutoScalingGroupName' => '<string>',
            'DefaultResult' => '<string>',
            'GlobalTimeout' => <integer>,
            'HeartbeatTimeout' => <integer>,
            'LifecycleHookName' => '<string>',
            'LifecycleTransition' => '<string>',
            'NotificationMetadata' => '<string>',
            'NotificationTargetARN' => '<string>',
            'RoleARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe your lifecycle hooks

This example describes the lifecycle hooks for the specified Auto Scaling group.

$result = $client->describeLifecycleHooks([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'LifecycleHooks' => [
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'DefaultResult' => 'ABANDON',
            'GlobalTimeout' => 172800,
            'HeartbeatTimeout' => 3600,
            'LifecycleHookName' => 'my-lifecycle-hook',
            'LifecycleTransition' => 'autoscaling:EC2_INSTANCE_LAUNCHING',
            'NotificationTargetARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
            'RoleARN' => 'arn:aws:iam::123456789012:role/my-auto-scaling-role',
        ],
    ],
]

DescribeLoadBalancerTargetGroups

$result = $client->describeLoadBalancerTargetGroups([/* ... */]);
$promise = $client->describeLoadBalancerTargetGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLoadBalancerTargetGroups([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LoadBalancerTargetGroups' => [
        [
            'LoadBalancerTargetGroupARN' => '<string>',
            'State' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the target groups for an Auto Scaling group

This example describes the target groups attached to the specified Auto Scaling group.

$result = $client->describeLoadBalancerTargetGroups([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'LoadBalancerTargetGroups' => [
        [
            'LoadBalancerTargetGroupARN' => 'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
            'State' => 'Added',
        ],
    ],
]

DescribeLoadBalancers

$result = $client->describeLoadBalancers([/* ... */]);
$promise = $client->describeLoadBalancersAsync([/* ... */]);

Parameter Syntax

$result = $client->describeLoadBalancers([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LoadBalancers' => [
        [
            'LoadBalancerName' => '<string>',
            'State' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the load balancers for an Auto Scaling group

This example describes the load balancers attached to the specified Auto Scaling group.

$result = $client->describeLoadBalancers([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'LoadBalancers' => [
        [
            'LoadBalancerName' => 'my-load-balancer',
            'State' => 'Added',
        ],
    ],
]

DescribeMetricCollectionTypes

$result = $client->describeMetricCollectionTypes([/* ... */]);
$promise = $client->describeMetricCollectionTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeMetricCollectionTypes([
]);

Parameter Details

Result Syntax

[
    'Granularities' => [
        [
            'Granularity' => '<string>',
        ],
        // ...
    ],
    'Metrics' => [
        [
            'Metric' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the Auto Scaling metric collection types

This example describes the available metric collection types.

$result = $client->describeMetricCollectionTypes([
]);

Result syntax:

[
    'Granularities' => [
        [
            'Granularity' => '1Minute',
        ],
    ],
    'Metrics' => [
        [
            'Metric' => 'GroupMinSize',
        ],
        [
            'Metric' => 'GroupMaxSize',
        ],
        [
            'Metric' => 'GroupDesiredCapacity',
        ],
        [
            'Metric' => 'GroupInServiceInstances',
        ],
        [
            'Metric' => 'GroupPendingInstances',
        ],
        [
            'Metric' => 'GroupTerminatingInstances',
        ],
        [
            'Metric' => 'GroupStandbyInstances',
        ],
        [
            'Metric' => 'GroupTotalInstances',
        ],
    ],
]

DescribeNotificationConfigurations

$result = $client->describeNotificationConfigurations([/* ... */]);
$promise = $client->describeNotificationConfigurationsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeNotificationConfigurations([
    'AutoScalingGroupNames' => ['<string>', ...],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'NotificationConfigurations' => [
        [
            'AutoScalingGroupName' => '<string>',
            'NotificationType' => '<string>',
            'TopicARN' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe Auto Scaling notification configurations

This example describes the notification configurations for the specified Auto Scaling group.

$result = $client->describeNotificationConfigurations([
    'AutoScalingGroupNames' => [
        'my-auto-scaling-group',
    ],
]);

Result syntax:

[
    'NotificationConfigurations' => [
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'NotificationType' => 'autoscaling:TEST_NOTIFICATION',
            'TopicARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic-2',
        ],
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'NotificationType' => 'autoscaling:TEST_NOTIFICATION',
            'TopicARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
        ],
    ],
]

DescribePolicies

$result = $client->describePolicies([/* ... */]);
$promise = $client->describePoliciesAsync([/* ... */]);

Parameter Syntax

$result = $client->describePolicies([
    'AutoScalingGroupName' => '<string>',
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
    'PolicyNames' => ['<string>', ...],
    'PolicyTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ScalingPolicies' => [
        [
            'AdjustmentType' => '<string>',
            'Alarms' => [
                [
                    'AlarmARN' => '<string>',
                    'AlarmName' => '<string>',
                ],
                // ...
            ],
            'AutoScalingGroupName' => '<string>',
            'Cooldown' => <integer>,
            'EstimatedInstanceWarmup' => <integer>,
            'MetricAggregationType' => '<string>',
            'MinAdjustmentMagnitude' => <integer>,
            'MinAdjustmentStep' => <integer>,
            'PolicyARN' => '<string>',
            'PolicyName' => '<string>',
            'PolicyType' => '<string>',
            'ScalingAdjustment' => <integer>,
            'StepAdjustments' => [
                [
                    'MetricIntervalLowerBound' => <float>,
                    'MetricIntervalUpperBound' => <float>,
                    'ScalingAdjustment' => <integer>,
                ],
                // ...
            ],
            'TargetTrackingConfiguration' => [
                'CustomizedMetricSpecification' => [
                    'Dimensions' => [
                        [
                            'Name' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'MetricName' => '<string>',
                    'Namespace' => '<string>',
                    'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum',
                    'Unit' => '<string>',
                ],
                'DisableScaleIn' => true || false,
                'PredefinedMetricSpecification' => [
                    'PredefinedMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|ALBRequestCountPerTarget',
                    'ResourceLabel' => '<string>',
                ],
                'TargetValue' => <float>,
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To describe Auto Scaling policies

This example describes the policies for the specified Auto Scaling group.

$result = $client->describePolicies([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'ScalingPolicies' => [
        [
            'AdjustmentType' => 'ChangeInCapacity',
            'Alarms' => [
            ],
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'PolicyARN' => 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn',
            'PolicyName' => 'ScaleIn',
            'ScalingAdjustment' => -1,
        ],
        [
            'AdjustmentType' => 'PercentChangeInCapacity',
            'Alarms' => [
            ],
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'Cooldown' => 60,
            'MinAdjustmentStep' => 2,
            'PolicyARN' => 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2b435159-cf77-4e89-8c0e-d63b497baad7:autoScalingGroupName/my-auto-scaling-group:policyName/ScalePercentChange',
            'PolicyName' => 'ScalePercentChange',
            'ScalingAdjustment' => 25,
        ],
    ],
]

DescribeScalingActivities

$result = $client->describeScalingActivities([/* ... */]);
$promise = $client->describeScalingActivitiesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeScalingActivities([
    'ActivityIds' => ['<string>', ...],
    'AutoScalingGroupName' => '<string>',
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Activities' => [
        [
            'ActivityId' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'Cause' => '<string>',
            'Description' => '<string>',
            'Details' => '<string>',
            'EndTime' => <DateTime>,
            'Progress' => <integer>,
            'StartTime' => <DateTime>,
            'StatusCode' => 'PendingSpotBidPlacement|WaitingForSpotInstanceRequestId|WaitingForSpotInstanceId|WaitingForInstanceId|PreInService|InProgress|WaitingForELBConnectionDraining|MidLifecycleAction|WaitingForInstanceWarmup|Successful|Failed|Cancelled',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the scaling activities for an Auto Scaling group

This example describes the scaling activities for the specified Auto Scaling group.

$result = $client->describeScalingActivities([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'Activities' => [
        [
            'ActivityId' => 'f9f2d65b-f1f2-43e7-b46d-d86756459699',
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'Cause' => 'At 2013-08-19T20:53:25Z a user request created an AutoScalingGroup changing the desired capacity from 0 to 1. At 2013-08-19T20:53:29Z an instance was started in response to a difference between desired and actual capacity, increasing the capacity from 0 to 1.',
            'Description' => 'Launching a new EC2 instance: i-4ba0837f',
            'Details' => 'details',
            'EndTime' => ,
            'Progress' => 100,
            'StartTime' => ,
            'StatusCode' => 'Successful',
        ],
    ],
]

DescribeScalingProcessTypes

$result = $client->describeScalingProcessTypes([/* ... */]);
$promise = $client->describeScalingProcessTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeScalingProcessTypes([
]);

Parameter Details

Result Syntax

[
    'Processes' => [
        [
            'ProcessName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe the Auto Scaling process types

This example describes the Auto Scaling process types.

$result = $client->describeScalingProcessTypes([
]);

Result syntax:

[
    'Processes' => [
        [
            'ProcessName' => 'AZRebalance',
        ],
        [
            'ProcessName' => 'AddToLoadBalancer',
        ],
        [
            'ProcessName' => 'AlarmNotification',
        ],
        [
            'ProcessName' => 'HealthCheck',
        ],
        [
            'ProcessName' => 'Launch',
        ],
        [
            'ProcessName' => 'ReplaceUnhealthy',
        ],
        [
            'ProcessName' => 'ScheduledActions',
        ],
        [
            'ProcessName' => 'Terminate',
        ],
    ],
]

DescribeScheduledActions

$result = $client->describeScheduledActions([/* ... */]);
$promise = $client->describeScheduledActionsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeScheduledActions([
    'AutoScalingGroupName' => '<string>',
    'EndTime' => <integer || string || DateTime>,
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
    'ScheduledActionNames' => ['<string>', ...],
    'StartTime' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ScheduledUpdateGroupActions' => [
        [
            'AutoScalingGroupName' => '<string>',
            'DesiredCapacity' => <integer>,
            'EndTime' => <DateTime>,
            'MaxSize' => <integer>,
            'MinSize' => <integer>,
            'Recurrence' => '<string>',
            'ScheduledActionARN' => '<string>',
            'ScheduledActionName' => '<string>',
            'StartTime' => <DateTime>,
            'Time' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe scheduled actions

This example describes the scheduled actions for the specified Auto Scaling group.

$result = $client->describeScheduledActions([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
]);

Result syntax:

[
    'ScheduledUpdateGroupActions' => [
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'DesiredCapacity' => 4,
            'MaxSize' => 6,
            'MinSize' => 2,
            'Recurrence' => '30 0 1 12 0',
            'ScheduledActionARN' => 'arn:aws:autoscaling:us-west-2:123456789012:scheduledUpdateGroupAction:8e86b655-b2e6-4410-8f29-b4f094d6871c:autoScalingGroupName/my-auto-scaling-group:scheduledActionName/my-scheduled-action',
            'ScheduledActionName' => 'my-scheduled-action',
            'StartTime' => ,
            'Time' => ,
        ],
    ],
]

DescribeTags

$result = $client->describeTags([/* ... */]);
$promise = $client->describeTagsAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTags([
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Tags' => [
        [
            'Key' => '<string>',
            'PropagateAtLaunch' => true || false,
            'ResourceId' => '<string>',
            'ResourceType' => '<string>',
            'Value' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe tags

This example describes the tags for the specified Auto Scaling group.

$result = $client->describeTags([
    'Filters' => [
        [
            'Name' => 'auto-scaling-group',
            'Values' => [
                'my-auto-scaling-group',
            ],
        ],
    ],
]);

Result syntax:

[
    'Tags' => [
        [
            'Key' => 'Dept',
            'PropagateAtLaunch' => 1,
            'ResourceId' => 'my-auto-scaling-group',
            'ResourceType' => 'auto-scaling-group',
            'Value' => 'Research',
        ],
        [
            'Key' => 'Role',
            'PropagateAtLaunch' => 1,
            'ResourceId' => 'my-auto-scaling-group',
            'ResourceType' => 'auto-scaling-group',
            'Value' => 'WebServer',
        ],
    ],
]

DescribeTerminationPolicyTypes

$result = $client->describeTerminationPolicyTypes([/* ... */]);
$promise = $client->describeTerminationPolicyTypesAsync([/* ... */]);

Parameter Syntax

$result = $client->describeTerminationPolicyTypes([
]);

Parameter Details

Result Syntax

[
    'TerminationPolicyTypes' => ['<string>', ...],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To describe termination policy types

This example describes the available termination policy types.

$result = $client->describeTerminationPolicyTypes([
]);

Result syntax:

[
    'TerminationPolicyTypes' => [
        'ClosestToNextInstanceHour',
        'Default',
        'NewestInstance',
        'OldestInstance',
        'OldestLaunchConfiguration',
    ],
]

DetachInstances

$result = $client->detachInstances([/* ... */]);
$promise = $client->detachInstancesAsync([/* ... */]);

Parameter Syntax

$result = $client->detachInstances([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
    'ShouldDecrementDesiredCapacity' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Activities' => [
        [
            'ActivityId' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'Cause' => '<string>',
            'Description' => '<string>',
            'Details' => '<string>',
            'EndTime' => <DateTime>,
            'Progress' => <integer>,
            'StartTime' => <DateTime>,
            'StatusCode' => 'PendingSpotBidPlacement|WaitingForSpotInstanceRequestId|WaitingForSpotInstanceId|WaitingForInstanceId|PreInService|InProgress|WaitingForELBConnectionDraining|MidLifecycleAction|WaitingForInstanceWarmup|Successful|Failed|Cancelled',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To detach an instance from an Auto Scaling group

This example detaches the specified instance from the specified Auto Scaling group.

$result = $client->detachInstances([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
    'ShouldDecrementDesiredCapacity' => 1,
]);

Result syntax:

[
    'Activities' => [
        [
            'ActivityId' => '5091cb52-547a-47ce-a236-c9ccbc2cb2c9',
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'Cause' => 'At 2015-04-12T15:02:16Z instance i-93633f9b was detached in response to a user request, shrinking the capacity from 2 to 1.',
            'Description' => 'Detaching EC2 instance: i-93633f9b',
            'Details' => 'details',
            'Progress' => 50,
            'StartTime' => ,
            'StatusCode' => 'InProgress',
        ],
    ],
]

DetachLoadBalancerTargetGroups

$result = $client->detachLoadBalancerTargetGroups([/* ... */]);
$promise = $client->detachLoadBalancerTargetGroupsAsync([/* ... */]);

Parameter Syntax

$result = $client->detachLoadBalancerTargetGroups([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'TargetGroupARNs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To detach a target group from an Auto Scaling group

This example detaches the specified target group from the specified Auto Scaling group

$result = $client->detachLoadBalancerTargetGroups([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'TargetGroupARNs' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
]);

DetachLoadBalancers

$result = $client->detachLoadBalancers([/* ... */]);
$promise = $client->detachLoadBalancersAsync([/* ... */]);

Parameter Syntax

$result = $client->detachLoadBalancers([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'LoadBalancerNames' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To detach a load balancer from an Auto Scaling group

This example detaches the specified load balancer from the specified Auto Scaling group.

$result = $client->detachLoadBalancers([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LoadBalancerNames' => [
        'my-load-balancer',
    ],
]);

DisableMetricsCollection

$result = $client->disableMetricsCollection([/* ... */]);
$promise = $client->disableMetricsCollectionAsync([/* ... */]);

Parameter Syntax

$result = $client->disableMetricsCollection([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'Metrics' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To disable metrics collection for an Auto Scaling group

This example disables collecting data for the GroupDesiredCapacity metric for the specified Auto Scaling group.

$result = $client->disableMetricsCollection([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'Metrics' => [
        'GroupDesiredCapacity',
    ],
]);

EnableMetricsCollection

$result = $client->enableMetricsCollection([/* ... */]);
$promise = $client->enableMetricsCollectionAsync([/* ... */]);

Parameter Syntax

$result = $client->enableMetricsCollection([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'Granularity' => '<string>', // REQUIRED
    'Metrics' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To enable metrics collection for an Auto Scaling group

This example enables data collection for the specified Auto Scaling group.

$result = $client->enableMetricsCollection([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'Granularity' => '1Minute',
]);

EnterStandby

$result = $client->enterStandby([/* ... */]);
$promise = $client->enterStandbyAsync([/* ... */]);

Parameter Syntax

$result = $client->enterStandby([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
    'ShouldDecrementDesiredCapacity' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Activities' => [
        [
            'ActivityId' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'Cause' => '<string>',
            'Description' => '<string>',
            'Details' => '<string>',
            'EndTime' => <DateTime>,
            'Progress' => <integer>,
            'StartTime' => <DateTime>,
            'StatusCode' => 'PendingSpotBidPlacement|WaitingForSpotInstanceRequestId|WaitingForSpotInstanceId|WaitingForInstanceId|PreInService|InProgress|WaitingForELBConnectionDraining|MidLifecycleAction|WaitingForInstanceWarmup|Successful|Failed|Cancelled',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To move instances into standby mode

This example puts the specified instance into standby mode.

$result = $client->enterStandby([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
    'ShouldDecrementDesiredCapacity' => 1,
]);

Result syntax:

[
    'Activities' => [
        [
            'ActivityId' => 'ffa056b4-6ed3-41ba-ae7c-249dfae6eba1',
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'Cause' => 'At 2015-04-12T15:10:23Z instance i-93633f9b was moved to standby in response to a user request, shrinking the capacity from 2 to 1.',
            'Description' => 'Moving EC2 instance to Standby: i-93633f9b',
            'Details' => 'details',
            'Progress' => 50,
            'StartTime' => ,
            'StatusCode' => 'InProgress',
        ],
    ],
]

ExecutePolicy

$result = $client->executePolicy([/* ... */]);
$promise = $client->executePolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->executePolicy([
    'AutoScalingGroupName' => '<string>',
    'BreachThreshold' => <float>,
    'HonorCooldown' => true || false,
    'MetricValue' => <float>,
    'PolicyName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ScalingActivityInProgressFault:

  The operation can't be performed because there are scaling activities in progress.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To execute an Auto Scaling policy

This example executes the specified Auto Scaling policy for the specified Auto Scaling group.

$result = $client->executePolicy([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'HonorCooldown' => 1,
    'PolicyName' => 'ScaleIn',
]);

ExitStandby

$result = $client->exitStandby([/* ... */]);
$promise = $client->exitStandbyAsync([/* ... */]);

Parameter Syntax

$result = $client->exitStandby([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'Activities' => [
        [
            'ActivityId' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'Cause' => '<string>',
            'Description' => '<string>',
            'Details' => '<string>',
            'EndTime' => <DateTime>,
            'Progress' => <integer>,
            'StartTime' => <DateTime>,
            'StatusCode' => 'PendingSpotBidPlacement|WaitingForSpotInstanceRequestId|WaitingForSpotInstanceId|WaitingForInstanceId|PreInService|InProgress|WaitingForELBConnectionDraining|MidLifecycleAction|WaitingForInstanceWarmup|Successful|Failed|Cancelled',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To move instances out of standby mode

This example moves the specified instance out of standby mode.

$result = $client->exitStandby([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
]);

Result syntax:

[
    'Activities' => [
        [
            'ActivityId' => '142928e1-a2dc-453a-9b24-b85ad6735928',
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'Cause' => 'At 2015-04-12T15:14:29Z instance i-93633f9b was moved out of standby in response to a user request, increasing the capacity from 1 to 2.',
            'Description' => 'Moving EC2 instance out of Standby: i-93633f9b',
            'Details' => 'details',
            'Progress' => 30,
            'StartTime' => ,
            'StatusCode' => 'PreInService',
        ],
    ],
]

PutLifecycleHook

$result = $client->putLifecycleHook([/* ... */]);
$promise = $client->putLifecycleHookAsync([/* ... */]);

Parameter Syntax

$result = $client->putLifecycleHook([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'DefaultResult' => '<string>',
    'HeartbeatTimeout' => <integer>,
    'LifecycleHookName' => '<string>', // REQUIRED
    'LifecycleTransition' => '<string>',
    'NotificationMetadata' => '<string>',
    'NotificationTargetARN' => '<string>',
    'RoleARN' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To create a lifecycle hook

This example creates a lifecycle hook.

$result = $client->putLifecycleHook([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LifecycleHookName' => 'my-lifecycle-hook',
    'LifecycleTransition' => 'autoscaling:EC2_INSTANCE_LAUNCHING',
    'NotificationTargetARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic --role-arn',
    'RoleARN' => 'arn:aws:iam::123456789012:role/my-auto-scaling-role',
]);

PutNotificationConfiguration

$result = $client->putNotificationConfiguration([/* ... */]);
$promise = $client->putNotificationConfigurationAsync([/* ... */]);

Parameter Syntax

$result = $client->putNotificationConfiguration([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'NotificationTypes' => ['<string>', ...], // REQUIRED
    'TopicARN' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To add an Auto Scaling notification

This example adds the specified notification to the specified Auto Scaling group.

$result = $client->putNotificationConfiguration([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'NotificationTypes' => [
        'autoscaling:TEST_NOTIFICATION',
    ],
    'TopicARN' => 'arn:aws:sns:us-west-2:123456789012:my-sns-topic',
]);

PutScalingPolicy

$result = $client->putScalingPolicy([/* ... */]);
$promise = $client->putScalingPolicyAsync([/* ... */]);

Parameter Syntax

$result = $client->putScalingPolicy([
    'AdjustmentType' => '<string>',
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'Cooldown' => <integer>,
    'EstimatedInstanceWarmup' => <integer>,
    'MetricAggregationType' => '<string>',
    'MinAdjustmentMagnitude' => <integer>,
    'MinAdjustmentStep' => <integer>,
    'PolicyName' => '<string>', // REQUIRED
    'PolicyType' => '<string>',
    'ScalingAdjustment' => <integer>,
    'StepAdjustments' => [
        [
            'MetricIntervalLowerBound' => <float>,
            'MetricIntervalUpperBound' => <float>,
            'ScalingAdjustment' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'TargetTrackingConfiguration' => [
        'CustomizedMetricSpecification' => [
            'Dimensions' => [
                [
                    'Name' => '<string>', // REQUIRED
                    'Value' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'MetricName' => '<string>', // REQUIRED
            'Namespace' => '<string>', // REQUIRED
            'Statistic' => 'Average|Minimum|Maximum|SampleCount|Sum', // REQUIRED
            'Unit' => '<string>',
        ],
        'DisableScaleIn' => true || false,
        'PredefinedMetricSpecification' => [
            'PredefinedMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|ALBRequestCountPerTarget', // REQUIRED
            'ResourceLabel' => '<string>',
        ],
        'TargetValue' => <float>, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[
    'Alarms' => [
        [
            'AlarmARN' => '<string>',
            'AlarmName' => '<string>',
        ],
        // ...
    ],
    'PolicyARN' => '<string>',
]

Result Details

Errors

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To add a scaling policy to an Auto Scaling group

This example adds the specified policy to the specified Auto Scaling group.

$result = $client->putScalingPolicy([
    'AdjustmentType' => 'ChangeInCapacity',
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'PolicyName' => 'ScaleIn',
    'ScalingAdjustment' => -1,
]);

Result syntax:

[
    'PolicyARN' => 'arn:aws:autoscaling:us-west-2:123456789012:scalingPolicy:2233f3d7-6290-403b-b632-93c553560106:autoScalingGroupName/my-auto-scaling-group:policyName/ScaleIn',
]

PutScheduledUpdateGroupAction

$result = $client->putScheduledUpdateGroupAction([/* ... */]);
$promise = $client->putScheduledUpdateGroupActionAsync([/* ... */]);

Parameter Syntax

$result = $client->putScheduledUpdateGroupAction([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'DesiredCapacity' => <integer>,
    'EndTime' => <integer || string || DateTime>,
    'MaxSize' => <integer>,
    'MinSize' => <integer>,
    'Recurrence' => '<string>',
    'ScheduledActionName' => '<string>', // REQUIRED
    'StartTime' => <integer || string || DateTime>,
    'Time' => <integer || string || DateTime>,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• AlreadyExistsFault:

  You already have an Auto Scaling group or launch configuration with this name.

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To add a scheduled action to an Auto Scaling group

This example adds the specified scheduled action to the specified Auto Scaling group.

$result = $client->putScheduledUpdateGroupAction([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'DesiredCapacity' => 4,
    'EndTime' => ,
    'MaxSize' => 6,
    'MinSize' => 2,
    'ScheduledActionName' => 'my-scheduled-action',
    'StartTime' => ,
]);

RecordLifecycleActionHeartbeat

$result = $client->recordLifecycleActionHeartbeat([/* ... */]);
$promise = $client->recordLifecycleActionHeartbeatAsync([/* ... */]);

Parameter Syntax

$result = $client->recordLifecycleActionHeartbeat([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceId' => '<string>',
    'LifecycleActionToken' => '<string>',
    'LifecycleHookName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To record a lifecycle action heartbeat

This example records a lifecycle action heartbeat to keep the instance in a pending state.

$result = $client->recordLifecycleActionHeartbeat([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LifecycleActionToken' => 'bcd2f1b8-9a78-44d3-8a7a-4dd07d7cf635',
    'LifecycleHookName' => 'my-lifecycle-hook',
]);

ResumeProcesses

$result = $client->resumeProcesses([/* ... */]);
$promise = $client->resumeProcessesAsync([/* ... */]);

Parameter Syntax

$result = $client->resumeProcesses([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'ScalingProcesses' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To resume Auto Scaling processes

This example resumes the specified suspended scaling process for the specified Auto Scaling group.

$result = $client->resumeProcesses([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'ScalingProcesses' => [
        'AlarmNotification',
    ],
]);

SetDesiredCapacity

$result = $client->setDesiredCapacity([/* ... */]);
$promise = $client->setDesiredCapacityAsync([/* ... */]);

Parameter Syntax

$result = $client->setDesiredCapacity([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'DesiredCapacity' => <integer>, // REQUIRED
    'HonorCooldown' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ScalingActivityInProgressFault:

  The operation can't be performed because there are scaling activities in progress.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To set the desired capacity for an Auto Scaling group

This example sets the desired capacity for the specified Auto Scaling group.

$result = $client->setDesiredCapacity([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'DesiredCapacity' => 2,
    'HonorCooldown' => 1,
]);

SetInstanceHealth

$result = $client->setInstanceHealth([/* ... */]);
$promise = $client->setInstanceHealthAsync([/* ... */]);

Parameter Syntax

$result = $client->setInstanceHealth([
    'HealthStatus' => '<string>', // REQUIRED
    'InstanceId' => '<string>', // REQUIRED
    'ShouldRespectGracePeriod' => true || false,
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To set the health status of an instance

This example sets the health status of the specified instance to Unhealthy.

$result = $client->setInstanceHealth([
    'HealthStatus' => 'Unhealthy',
    'InstanceId' => 'i-93633f9b',
]);

SetInstanceProtection

$result = $client->setInstanceProtection([/* ... */]);
$promise = $client->setInstanceProtectionAsync([/* ... */]);

Parameter Syntax

$result = $client->setInstanceProtection([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'InstanceIds' => ['<string>', ...], // REQUIRED
    'ProtectedFromScaleIn' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• LimitExceededFault:

  You have already reached a limit for your Auto Scaling resources (for example, groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To enable instance protection for an instance

This example enables instance protection for the specified instance.

$result = $client->setInstanceProtection([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
    'ProtectedFromScaleIn' => 1,
]);

Example 2: To disable instance protection for an instance

This example disables instance protection for the specified instance.

$result = $client->setInstanceProtection([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'InstanceIds' => [
        'i-93633f9b',
    ],
    'ProtectedFromScaleIn' => ,
]);

SuspendProcesses

$result = $client->suspendProcesses([/* ... */]);
$promise = $client->suspendProcessesAsync([/* ... */]);

Parameter Syntax

$result = $client->suspendProcesses([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'ScalingProcesses' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ResourceInUseFault:

  The operation can't be performed because the resource is in use.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To suspend Auto Scaling processes

This example suspends the specified scaling process for the specified Auto Scaling group.

$result = $client->suspendProcesses([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'ScalingProcesses' => [
        'AlarmNotification',
    ],
]);

TerminateInstanceInAutoScalingGroup

$result = $client->terminateInstanceInAutoScalingGroup([/* ... */]);
$promise = $client->terminateInstanceInAutoScalingGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->terminateInstanceInAutoScalingGroup([
    'InstanceId' => '<string>', // REQUIRED
    'ShouldDecrementDesiredCapacity' => true || false, // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Activity' => [
        'ActivityId' => '<string>',
        'AutoScalingGroupName' => '<string>',
        'Cause' => '<string>',
        'Description' => '<string>',
        'Details' => '<string>',
        'EndTime' => <DateTime>,
        'Progress' => <integer>,
        'StartTime' => <DateTime>,
        'StatusCode' => 'PendingSpotBidPlacement|WaitingForSpotInstanceRequestId|WaitingForSpotInstanceId|WaitingForInstanceId|PreInService|InProgress|WaitingForELBConnectionDraining|MidLifecycleAction|WaitingForInstanceWarmup|Successful|Failed|Cancelled',
        'StatusMessage' => '<string>',
    ],
]

Result Details

Errors

• ScalingActivityInProgressFault:

  The operation can't be performed because there are scaling activities in progress.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

Examples

Example 1: To terminate an instance in an Auto Scaling group

This example terminates the specified instance from the specified Auto Scaling group without updating the size of the group. Auto Scaling launches a replacement instance after the specified instance terminates.

$result = $client->terminateInstanceInAutoScalingGroup([
    'InstanceId' => 'i-93633f9b',
    'ShouldDecrementDesiredCapacity' => ,
]);

UpdateAutoScalingGroup

$result = $client->updateAutoScalingGroup([/* ... */]);
$promise = $client->updateAutoScalingGroupAsync([/* ... */]);

Parameter Syntax

$result = $client->updateAutoScalingGroup([
    'AutoScalingGroupName' => '<string>', // REQUIRED
    'AvailabilityZones' => ['<string>', ...],
    'DefaultCooldown' => <integer>,
    'DesiredCapacity' => <integer>,
    'HealthCheckGracePeriod' => <integer>,
    'HealthCheckType' => '<string>',
    'LaunchConfigurationName' => '<string>',
    'LaunchTemplate' => [
        'LaunchTemplateId' => '<string>',
        'LaunchTemplateName' => '<string>',
        'Version' => '<string>',
    ],
    'MaxSize' => <integer>,
    'MinSize' => <integer>,
    'NewInstancesProtectedFromScaleIn' => true || false,
    'PlacementGroup' => '<string>',
    'ServiceLinkedRoleARN' => '<string>',
    'TerminationPolicies' => ['<string>', ...],
    'VPCZoneIdentifier' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• ScalingActivityInProgressFault:

  The operation can't be performed because there are scaling activities in progress.

• ResourceContentionFault:

  You already have a pending update to an Auto Scaling resource (for example, a group, instance, or load balancer).

• ServiceLinkedRoleFailure:

  The service-linked role is not yet ready for use.

Examples

Example 1: To update the launch configuration

This example updates the launch configuration of the specified Auto Scaling group.

$result = $client->updateAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'LaunchConfigurationName' => 'new-launch-config',
]);

Example 2: To update the minimum and maximum size

This example updates the minimum size and maximum size of the specified Auto Scaling group.

$result = $client->updateAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'MaxSize' => 3,
    'MinSize' => 1,
]);

Example 3: To enable instance protection

This example enables instance protection for the specified Auto Scaling group.

$result = $client->updateAutoScalingGroup([
    'AutoScalingGroupName' => 'my-auto-scaling-group',
    'NewInstancesProtectedFromScaleIn' => 1,
]);