DetachTrafficSourcesCommand

Suggest an Edit

Detaches one or more traffic sources from the specified Auto Scaling group.

When you detach a traffic source, it enters the Removing state while deregistering the instances in the group. When all instances are deregistered, then you can no longer describe the traffic source using the DescribeTrafficSources  API call. The instances continue to run.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { AutoScalingClient, DetachTrafficSourcesCommand } from "@aws-sdk/client-auto-scaling"; // ES Modules import
// const { AutoScalingClient, DetachTrafficSourcesCommand } = require("@aws-sdk/client-auto-scaling"); // CommonJS import
const client = new AutoScalingClient(config);
const input = { // DetachTrafficSourcesType
  AutoScalingGroupName: "STRING_VALUE", // required
  TrafficSources: [ // TrafficSources // required
    { // TrafficSourceIdentifier
      Identifier: "STRING_VALUE", // required
      Type: "STRING_VALUE",
    },
  ],
};
const command = new DetachTrafficSourcesCommand(input);
const response = await client.send(command);
// {};

Example Usage

 Loading code editor

DetachTrafficSourcesCommand Input

See DetachTrafficSourcesCommandInput for more details

Parameter
Type
Description
AutoScalingGroupName
Required
string | undefined

The name of the Auto Scaling group.

TrafficSources
Required
TrafficSourceIdentifier[] | undefined

The unique identifiers of one or more traffic sources. You can specify up to 10 traffic sources.

DetachTrafficSourcesCommand Output

See DetachTrafficSourcesCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ResourceContentionFault
server

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

AutoScalingServiceException
Base exception class for all service exceptions from AutoScaling service.