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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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',
    ],
]);

BatchDeleteScheduledAction

$result = $client->batchDeleteScheduledAction([/* ... */]);
$promise = $client->batchDeleteScheduledActionAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FailedScheduledActions' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ScheduledActionName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• ResourceContentionFault:

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

BatchPutScheduledUpdateGroupAction

$result = $client->batchPutScheduledUpdateGroupAction([/* ... */]);
$promise = $client->batchPutScheduledUpdateGroupActionAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'FailedScheduledUpdateGroupActions' => [
        [
            'ErrorCode' => '<string>',
            'ErrorMessage' => '<string>',
            'ScheduledActionName' => '<string>',
        ],
        // ...
    ],
]

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 Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.

• ResourceContentionFault:

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

CancelInstanceRefresh

$result = $client->cancelInstanceRefresh([/* ... */]);
$promise = $client->cancelInstanceRefreshAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InstanceRefreshId' => '<string>',
]

Result Details

Errors

• LimitExceededFault:

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

• ResourceContentionFault:

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

• ActiveInstanceRefreshNotFoundFault:

  The request failed because an active instance refresh for the specified Auto Scaling group was not found.

Examples

Example 1: To cancel an instance refresh

This example cancels an instance refresh operation in progress.

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

Result syntax:

[
    'InstanceRefreshId' => '08b91cf7-8fa6-48af-b6a6-d227f40f1b9b',
]

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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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>', ...],
    'CapacityRebalance' => true || false,
    'Context' => '<string>',
    'DefaultCooldown' => <integer>,
    'DesiredCapacity' => <integer>,
    'DesiredCapacityType' => '<string>',
    '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>', ...],
    'MaxInstanceLifetime' => <integer>,
    'MaxSize' => <integer>, // REQUIRED
    'MinSize' => <integer>, // REQUIRED
    'MixedInstancesPolicy' => [
        'InstancesDistribution' => [
            'OnDemandAllocationStrategy' => '<string>',
            'OnDemandBaseCapacity' => <integer>,
            'OnDemandPercentageAboveBaseCapacity' => <integer>,
            'SpotAllocationStrategy' => '<string>',
            'SpotInstancePools' => <integer>,
            'SpotMaxPrice' => '<string>',
        ],
        'LaunchTemplate' => [
            'LaunchTemplateSpecification' => [
                'LaunchTemplateId' => '<string>',
                'LaunchTemplateName' => '<string>',
                'Version' => '<string>',
            ],
            'Overrides' => [
                [
                    'InstanceRequirements' => [
                        'AcceleratorCount' => [
                            'Max' => <integer>,
                            'Min' => <integer>,
                        ],
                        'AcceleratorManufacturers' => ['<string>', ...],
                        'AcceleratorNames' => ['<string>', ...],
                        'AcceleratorTotalMemoryMiB' => [
                            'Max' => <integer>,
                            'Min' => <integer>,
                        ],
                        'AcceleratorTypes' => ['<string>', ...],
                        'BareMetal' => 'included|excluded|required',
                        'BaselineEbsBandwidthMbps' => [
                            'Max' => <integer>,
                            'Min' => <integer>,
                        ],
                        'BurstablePerformance' => 'included|excluded|required',
                        'CpuManufacturers' => ['<string>', ...],
                        'ExcludedInstanceTypes' => ['<string>', ...],
                        'InstanceGenerations' => ['<string>', ...],
                        'LocalStorage' => 'included|excluded|required',
                        'LocalStorageTypes' => ['<string>', ...],
                        'MemoryGiBPerVCpu' => [
                            'Max' => <float>,
                            'Min' => <float>,
                        ],
                        'MemoryMiB' => [ // REQUIRED
                            'Max' => <integer>,
                            'Min' => <integer>, // REQUIRED
                        ],
                        'NetworkInterfaceCount' => [
                            'Max' => <integer>,
                            'Min' => <integer>,
                        ],
                        'OnDemandMaxPricePercentageOverLowestPrice' => <integer>,
                        'RequireHibernateSupport' => true || false,
                        'SpotMaxPricePercentageOverLowestPrice' => <integer>,
                        'TotalLocalStorageGB' => [
                            'Max' => <float>,
                            'Min' => <float>,
                        ],
                        'VCpuCount' => [ // REQUIRED
                            'Max' => <integer>,
                            'Min' => <integer>, // REQUIRED
                        ],
                    ],
                    'InstanceType' => '<string>',
                    'LaunchTemplateSpecification' => [
                        'LaunchTemplateId' => '<string>',
                        'LaunchTemplateName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'WeightedCapacity' => '<string>',
                ],
                // ...
            ],
        ],
    ],
    '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 Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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',
    'LaunchTemplate' => [
        'LaunchTemplateId' => 'lt-0a20c965061f64abc',
        'Version' => '$Latest',
    ],
    'MaxInstanceLifetime' => 2592000,
    'MaxSize' => 3,
    'MinSize' => 1,
    'VPCZoneIdentifier' => 'subnet-057fa0918fEXAMPLE',
]);

Example 2: 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' => 300,
    'HealthCheckType' => 'ELB',
    'LaunchTemplate' => [
        'LaunchTemplateId' => 'lt-0a20c965061f64abc',
        'Version' => '$Default',
    ],
    'MaxSize' => 3,
    'MinSize' => 1,
    'TargetGroupARNs' => [
        'arn:aws:elasticloadbalancing:us-west-2:123456789012:targetgroup/my-targets/73e2d6bc24d8a067',
    ],
    'VPCZoneIdentifier' => 'subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE',
]);

Example 3: To create an Auto Scaling group with a mixed instances policy

This example creates an Auto Scaling group with a mixed instances policy. It specifies the c5.large, c5a.large, and c6g.large instance types and defines a different launch template for the c6g.large instance type.

$result = $client->createAutoScalingGroup([
    'AutoScalingGroupName' => 'my-asg',
    'DesiredCapacity' => 3,
    'MaxSize' => 5,
    'MinSize' => 1,
    'MixedInstancesPolicy' => [
        'InstancesDistribution' => [
            'OnDemandBaseCapacity' => 1,
            'OnDemandPercentageAboveBaseCapacity' => 50,
            'SpotAllocationStrategy' => 'capacity-optimized',
        ],
        'LaunchTemplate' => [
            'LaunchTemplateSpecification' => [
                'LaunchTemplateName' => 'my-launch-template-for-x86',
                'Version' => '$Latest',
            ],
            'Overrides' => [
                [
                    'InstanceType' => 'c6g.large',
                    'LaunchTemplateSpecification' => [
                        'LaunchTemplateName' => 'my-launch-template-for-arm',
                        'Version' => '$Latest',
                    ],
                ],
                [
                    'InstanceType' => 'c5.large',
                ],
                [
                    'InstanceType' => 'c5a.large',
                ],
            ],
        ],
    ],
    'VPCZoneIdentifier' => 'subnet-057fa0918fEXAMPLE, subnet-610acd08EXAMPLE',
]);

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>',
                'Throughput' => <integer>,
                '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
    'MetadataOptions' => [
        'HttpEndpoint' => 'disabled|enabled',
        'HttpPutResponseHopLimit' => <integer>,
        'HttpTokens' => 'optional|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 Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resources (for example, Auto Scaling groups, launch configurations, or lifecycle hooks). For more information, see DescribeAccountLimits in the Amazon EC2 Auto Scaling API Reference.

• AlreadyExistsFault:

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

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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' => 'my-step-scale-out-policy',
]);

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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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',
        ],
    ],
]);

DeleteWarmPool

$result = $client->deleteWarmPool([/* ... */]);
$promise = $client->deleteWarmPoolAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• LimitExceededFault:

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

• ResourceContentionFault:

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

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

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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

Example 1: To describe your Auto Scaling account limits

This example describes the Amazon EC2 Auto Scaling service quotas for your 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

Examples

Example 1: To describe the Amazon EC2 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>', ...],
    'Filters' => [
        [
            'Name' => '<string>',
            'Values' => ['<string>', ...],
        ],
        // ...
    ],
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'AutoScalingGroups' => [
        [
            'AutoScalingGroupARN' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'AvailabilityZones' => ['<string>', ...],
            'CapacityRebalance' => true || false,
            'Context' => '<string>',
            'CreatedTime' => <DateTime>,
            'DefaultCooldown' => <integer>,
            'DesiredCapacity' => <integer>,
            'DesiredCapacityType' => '<string>',
            'EnabledMetrics' => [
                [
                    'Granularity' => '<string>',
                    'Metric' => '<string>',
                ],
                // ...
            ],
            'HealthCheckGracePeriod' => <integer>,
            'HealthCheckType' => '<string>',
            'Instances' => [
                [
                    'AvailabilityZone' => '<string>',
                    'HealthStatus' => '<string>',
                    'InstanceId' => '<string>',
                    'InstanceType' => '<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|Warmed:Pending|Warmed:Pending:Wait|Warmed:Pending:Proceed|Warmed:Terminating|Warmed:Terminating:Wait|Warmed:Terminating:Proceed|Warmed:Terminated|Warmed:Stopped|Warmed:Running',
                    'ProtectedFromScaleIn' => true || false,
                    'WeightedCapacity' => '<string>',
                ],
                // ...
            ],
            'LaunchConfigurationName' => '<string>',
            'LaunchTemplate' => [
                'LaunchTemplateId' => '<string>',
                'LaunchTemplateName' => '<string>',
                'Version' => '<string>',
            ],
            'LoadBalancerNames' => ['<string>', ...],
            'MaxInstanceLifetime' => <integer>,
            'MaxSize' => <integer>,
            'MinSize' => <integer>,
            'MixedInstancesPolicy' => [
                'InstancesDistribution' => [
                    'OnDemandAllocationStrategy' => '<string>',
                    'OnDemandBaseCapacity' => <integer>,
                    'OnDemandPercentageAboveBaseCapacity' => <integer>,
                    'SpotAllocationStrategy' => '<string>',
                    'SpotInstancePools' => <integer>,
                    'SpotMaxPrice' => '<string>',
                ],
                'LaunchTemplate' => [
                    'LaunchTemplateSpecification' => [
                        'LaunchTemplateId' => '<string>',
                        'LaunchTemplateName' => '<string>',
                        'Version' => '<string>',
                    ],
                    'Overrides' => [
                        [
                            'InstanceRequirements' => [
                                'AcceleratorCount' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                                'AcceleratorManufacturers' => ['<string>', ...],
                                'AcceleratorNames' => ['<string>', ...],
                                'AcceleratorTotalMemoryMiB' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                                'AcceleratorTypes' => ['<string>', ...],
                                'BareMetal' => 'included|excluded|required',
                                'BaselineEbsBandwidthMbps' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                                'BurstablePerformance' => 'included|excluded|required',
                                'CpuManufacturers' => ['<string>', ...],
                                'ExcludedInstanceTypes' => ['<string>', ...],
                                'InstanceGenerations' => ['<string>', ...],
                                'LocalStorage' => 'included|excluded|required',
                                'LocalStorageTypes' => ['<string>', ...],
                                'MemoryGiBPerVCpu' => [
                                    'Max' => <float>,
                                    'Min' => <float>,
                                ],
                                'MemoryMiB' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                                'NetworkInterfaceCount' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                                'OnDemandMaxPricePercentageOverLowestPrice' => <integer>,
                                'RequireHibernateSupport' => true || false,
                                'SpotMaxPricePercentageOverLowestPrice' => <integer>,
                                'TotalLocalStorageGB' => [
                                    'Max' => <float>,
                                    'Min' => <float>,
                                ],
                                'VCpuCount' => [
                                    'Max' => <integer>,
                                    'Min' => <integer>,
                                ],
                            ],
                            'InstanceType' => '<string>',
                            'LaunchTemplateSpecification' => [
                                'LaunchTemplateId' => '<string>',
                                'LaunchTemplateName' => '<string>',
                                'Version' => '<string>',
                            ],
                            'WeightedCapacity' => '<string>',
                        ],
                        // ...
                    ],
                ],
            ],
            'NewInstancesProtectedFromScaleIn' => true || false,
            'PlacementGroup' => '<string>',
            'PredictedCapacity' => <integer>,
            '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>',
            'WarmPoolConfiguration' => [
                'MaxGroupPreparedCapacity' => <integer>,
                'MinSize' => <integer>,
                'PoolState' => 'Stopped|Running',
                'Status' => 'PendingDelete',
            ],
            'WarmPoolSize' => <integer>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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>',
            'InstanceType' => '<string>',
            'LaunchConfigurationName' => '<string>',
            'LaunchTemplate' => [
                'LaunchTemplateId' => '<string>',
                'LaunchTemplateName' => '<string>',
                'Version' => '<string>',
            ],
            'LifecycleState' => '<string>',
            'ProtectedFromScaleIn' => true || false,
            'WeightedCapacity' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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',
    ],
]

DescribeInstanceRefreshes

$result = $client->describeInstanceRefreshes([/* ... */]);
$promise = $client->describeInstanceRefreshesAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InstanceRefreshes' => [
        [
            'AutoScalingGroupName' => '<string>',
            'DesiredConfiguration' => [
                'LaunchTemplate' => [
                    'LaunchTemplateId' => '<string>',
                    'LaunchTemplateName' => '<string>',
                    'Version' => '<string>',
                ],
                'MixedInstancesPolicy' => [
                    'InstancesDistribution' => [
                        'OnDemandAllocationStrategy' => '<string>',
                        'OnDemandBaseCapacity' => <integer>,
                        'OnDemandPercentageAboveBaseCapacity' => <integer>,
                        'SpotAllocationStrategy' => '<string>',
                        'SpotInstancePools' => <integer>,
                        'SpotMaxPrice' => '<string>',
                    ],
                    'LaunchTemplate' => [
                        'LaunchTemplateSpecification' => [
                            'LaunchTemplateId' => '<string>',
                            'LaunchTemplateName' => '<string>',
                            'Version' => '<string>',
                        ],
                        'Overrides' => [
                            [
                                'InstanceRequirements' => [
                                    'AcceleratorCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorManufacturers' => ['<string>', ...],
                                    'AcceleratorNames' => ['<string>', ...],
                                    'AcceleratorTotalMemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'AcceleratorTypes' => ['<string>', ...],
                                    'BareMetal' => 'included|excluded|required',
                                    'BaselineEbsBandwidthMbps' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'BurstablePerformance' => 'included|excluded|required',
                                    'CpuManufacturers' => ['<string>', ...],
                                    'ExcludedInstanceTypes' => ['<string>', ...],
                                    'InstanceGenerations' => ['<string>', ...],
                                    'LocalStorage' => 'included|excluded|required',
                                    'LocalStorageTypes' => ['<string>', ...],
                                    'MemoryGiBPerVCpu' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'MemoryMiB' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'NetworkInterfaceCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                    'OnDemandMaxPricePercentageOverLowestPrice' => <integer>,
                                    'RequireHibernateSupport' => true || false,
                                    'SpotMaxPricePercentageOverLowestPrice' => <integer>,
                                    'TotalLocalStorageGB' => [
                                        'Max' => <float>,
                                        'Min' => <float>,
                                    ],
                                    'VCpuCount' => [
                                        'Max' => <integer>,
                                        'Min' => <integer>,
                                    ],
                                ],
                                'InstanceType' => '<string>',
                                'LaunchTemplateSpecification' => [
                                    'LaunchTemplateId' => '<string>',
                                    'LaunchTemplateName' => '<string>',
                                    'Version' => '<string>',
                                ],
                                'WeightedCapacity' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
            ],
            'EndTime' => <DateTime>,
            'InstanceRefreshId' => '<string>',
            'InstancesToUpdate' => <integer>,
            'PercentageComplete' => <integer>,
            'Preferences' => [
                'CheckpointDelay' => <integer>,
                'CheckpointPercentages' => [<integer>, ...],
                'InstanceWarmup' => <integer>,
                'MinHealthyPercentage' => <integer>,
                'SkipMatching' => true || false,
            ],
            'ProgressDetails' => [
                'LivePoolProgress' => [
                    'InstancesToUpdate' => <integer>,
                    'PercentageComplete' => <integer>,
                ],
                'WarmPoolProgress' => [
                    'InstancesToUpdate' => <integer>,
                    'PercentageComplete' => <integer>,
                ],
            ],
            'StartTime' => <DateTime>,
            'Status' => 'Pending|InProgress|Successful|Failed|Cancelling|Cancelled',
            'StatusReason' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

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

Examples

Example 1: To list instance refreshes

This example describes the instance refreshes for the specified Auto Scaling group.

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

Result syntax:

[
    'InstanceRefreshes' => [
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'InstanceRefreshId' => '08b91cf7-8fa6-48af-b6a6-d227f40f1b9b',
            'InstancesToUpdate' => 5,
            'PercentageComplete' => 0,
            'StartTime' => ,
            'Status' => 'InProgress',
        ],
        [
            'AutoScalingGroupName' => 'my-auto-scaling-group',
            'EndTime' => ,
            'InstanceRefreshId' => 'dd7728d0-5bc4-4575-96a3-1b2c52bf8bb1',
            'InstancesToUpdate' => 0,
            'PercentageComplete' => 100,
            'StartTime' => ,
            'Status' => 'Successful',
        ],
    ],
]

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>',
                        'Throughput' => <integer>,
                        '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>',
            'MetadataOptions' => [
                'HttpEndpoint' => 'disabled|enabled',
                'HttpPutResponseHopLimit' => <integer>,
                'HttpTokens' => 'optional|required',
            ],
            '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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

• InvalidNextToken:

  The NextToken value is not valid.

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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

• InvalidNextToken:

  The NextToken value is not valid.

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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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>,
            'Enabled' => true || false,
            'EstimatedInstanceWarmup' => <integer>,
            'MetricAggregationType' => '<string>',
            'MinAdjustmentMagnitude' => <integer>,
            'MinAdjustmentStep' => <integer>,
            'PolicyARN' => '<string>',
            'PolicyName' => '<string>',
            'PolicyType' => '<string>',
            'PredictiveScalingConfiguration' => [
                'MaxCapacityBreachBehavior' => 'HonorMaxCapacity|IncreaseMaxCapacity',
                'MaxCapacityBuffer' => <integer>,
                'MetricSpecifications' => [
                    [
                        'CustomizedCapacityMetricSpecification' => [
                            'MetricDataQueries' => [
                                [
                                    'Expression' => '<string>',
                                    'Id' => '<string>',
                                    'Label' => '<string>',
                                    'MetricStat' => [
                                        'Metric' => [
                                            'Dimensions' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'MetricName' => '<string>',
                                            'Namespace' => '<string>',
                                        ],
                                        'Stat' => '<string>',
                                        'Unit' => '<string>',
                                    ],
                                    'ReturnData' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        'CustomizedLoadMetricSpecification' => [
                            'MetricDataQueries' => [
                                [
                                    'Expression' => '<string>',
                                    'Id' => '<string>',
                                    'Label' => '<string>',
                                    'MetricStat' => [
                                        'Metric' => [
                                            'Dimensions' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'MetricName' => '<string>',
                                            'Namespace' => '<string>',
                                        ],
                                        'Stat' => '<string>',
                                        'Unit' => '<string>',
                                    ],
                                    'ReturnData' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        'CustomizedScalingMetricSpecification' => [
                            'MetricDataQueries' => [
                                [
                                    'Expression' => '<string>',
                                    'Id' => '<string>',
                                    'Label' => '<string>',
                                    'MetricStat' => [
                                        'Metric' => [
                                            'Dimensions' => [
                                                [
                                                    'Name' => '<string>',
                                                    'Value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'MetricName' => '<string>',
                                            'Namespace' => '<string>',
                                        ],
                                        'Stat' => '<string>',
                                        'Unit' => '<string>',
                                    ],
                                    'ReturnData' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        'PredefinedLoadMetricSpecification' => [
                            'PredefinedMetricType' => 'ASGTotalCPUUtilization|ASGTotalNetworkIn|ASGTotalNetworkOut|ALBTargetGroupRequestCount',
                            'ResourceLabel' => '<string>',
                        ],
                        'PredefinedMetricPairSpecification' => [
                            'PredefinedMetricType' => 'ASGCPUUtilization|ASGNetworkIn|ASGNetworkOut|ALBRequestCount',
                            'ResourceLabel' => '<string>',
                        ],
                        'PredefinedScalingMetricSpecification' => [
                            'PredefinedMetricType' => 'ASGAverageCPUUtilization|ASGAverageNetworkIn|ASGAverageNetworkOut|ALBRequestCountPerTarget',
                            'ResourceLabel' => '<string>',
                        ],
                        'TargetValue' => <float>,
                    ],
                    // ...
                ],
                'Mode' => 'ForecastAndScale|ForecastOnly',
                'SchedulingBufferTime' => <integer>,
            ],
            '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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling group, instance, or load balancer).

• ServiceLinkedRoleFailure:

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

Examples

Example 1: To describe 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>',
    'IncludeDeletedGroups' => true || false,
    'MaxRecords' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Activities' => [
        [
            'ActivityId' => '<string>',
            'AutoScalingGroupARN' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'AutoScalingGroupState' => '<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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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>,
            'TimeZone' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• ResourceContentionFault:

  You already have a pending update to an Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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',
    ],
]

DescribeWarmPool

$result = $client->describeWarmPool([/* ... */]);
$promise = $client->describeWarmPoolAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Instances' => [
        [
            'AvailabilityZone' => '<string>',
            'HealthStatus' => '<string>',
            'InstanceId' => '<string>',
            'InstanceType' => '<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|Warmed:Pending|Warmed:Pending:Wait|Warmed:Pending:Proceed|Warmed:Terminating|Warmed:Terminating:Wait|Warmed:Terminating:Proceed|Warmed:Terminated|Warmed:Stopped|Warmed:Running',
            'ProtectedFromScaleIn' => true || false,
            'WeightedCapacity' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'WarmPoolConfiguration' => [
        'MaxGroupPreparedCapacity' => <integer>,
        'MinSize' => <integer>,
        'PoolState' => 'Stopped|Running',
        'Status' => 'PendingDelete',
    ],
]

Result Details

Errors

• InvalidNextToken:

  The NextToken value is not valid.

• LimitExceededFault:

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

• ResourceContentionFault:

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

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>',
            'AutoScalingGroupARN' => '<string>',
            'AutoScalingGroupName' => '<string>',
            'AutoScalingGroupState' => '<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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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 Amazon EC2 Auto Scaling resource (for example, an Auto Scaling 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