Skip to content

add_tags 

add_tags(
    load_balancer_names: LoadBalancerNames,
    tags: TagList,
    *,
    config_overrides: Optional[ElasticLoadBalancingClientConfig] = None,
) -> AddTagsOutput

Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.

Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, AddTags updates its value.

For more information, see Tag Your Classic Load Balancer in the Classic Load Balancers Guide.

Parameters:

  • load_balancer_names (LoadBalancerNames) –

    The name of the load balancer. You can specify one load balancer only.

  • tags (TagList) –

    The tags.

Raises:

Examples:

To add tags to a load balancer This example adds two tags to the specified load balancer.

>>> client.add_tags(load_balancer_names=['my-load-balancer'], tags=[{'Key': 'project', 'Value': 'lima'}, {'Key': 'department', 'Value': 'digital-media'}])
Source code in docs_src/capo_elastic_load_balancing/_services/elastic_load_balancing.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
def add_tags(
    self,
    load_balancer_names: "capo_elastic_load_balancing.types.load_balancer_names.LoadBalancerNames",
    tags: "capo_elastic_load_balancing.types.tag_list.TagList",
    *,
    config_overrides: Optional[ElasticLoadBalancingClientConfig] = None,
) -> "capo_elastic_load_balancing.types.add_tags_output.AddTagsOutput":
    """<p>Adds the specified tags to the specified load balancer. Each load balancer can have a maximum of 10 tags.</p> <p>Each tag consists of a key and an optional value. If a tag with the same key is already associated with the load balancer, <code>AddTags</code> updates its value.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/add-remove-tags.html">Tag Your Classic Load Balancer</a> in the <i>Classic Load Balancers Guide</i>.</p>

    Args:
        load_balancer_names: <p>The name of the load balancer. You can specify one load balancer only.</p>
        tags: <p>The tags.</p>

    Raises:
        capo_elastic_load_balancing.errors.access_point_not_found_exception.AccessPointNotFoundException: <p>The specified load balancer does not exist.</p>
        capo_elastic_load_balancing.errors.duplicate_tag_keys_exception.DuplicateTagKeysException: <p>A tag key was specified more than once.</p>
        capo_elastic_load_balancing.errors.too_many_tags_exception.TooManyTagsException: <p>The quota for the number of tags that can be assigned to a load balancer has been reached.</p>
        capo_elastic_load_balancing.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To add tags to a load balancer
        This example adds two tags to the specified load balancer.

        >>> client.add_tags(load_balancer_names=['my-load-balancer'], tags=[{'Key': 'project', 'Value': 'lima'}, {'Key': 'department', 'Value': 'digital-media'}])
    """

    def _handler(
        req: "OperationRequest[capo_elastic_load_balancing.types.add_tags_input.AddTagsInput]",
    ) -> OperationResponse[
        "capo_elastic_load_balancing.types.add_tags_output.AddTagsOutput"
    ]:
        import capo_elastic_load_balancing._operations.elastic_load_balancing_v7.add_tags

        output, http_response = (
            capo_elastic_load_balancing._operations.elastic_load_balancing_v7.add_tags.add_tags(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("AddTags")
    )
    input_: capo_elastic_load_balancing.types.add_tags_input.AddTagsInput = {
        "load_balancer_names": load_balancer_names,
        "tags": tags,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output