Skip to content

delete_service_attributes

delete_service_attributes(
    service_id: Arn,
    attributes: ServiceAttributeKeyList,
    *,
    config_overrides: Optional[ServiceDiscoveryClientConfig] = None,
) -> DeleteServiceAttributesResponse

Deletes specific attributes associated with a service.

Parameters:

  • service_id (Arn) –

    The ID or Amazon Resource Name (ARN) of the service from which the attributes will be deleted. For services created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information about shared namespaces, see Cross-account Cloud Map namespace sharing in the Cloud Map Developer Guide.

  • attributes (ServiceAttributeKeyList) –

    A list of keys corresponding to each attribute that you want to delete.

Raises:

  • InvalidInput –

    One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.

  • ServiceNotFound –

    No service exists with the specified ID.

  • UnknownServiceError –

    The service returned an error code this client does not model.

Examples:

DeleteServiceAttributes example Example: Delete service attribute by providing attribute key and service ID

>>> client.delete_service_attributes(attributes=['port'], service_id='srv-e4anhexample0004')
Delete service attributes using service ARN
Deletes service attributes using a service ARN instead of service ID, useful for cross-account scenarios or when working with shared namespaces.
>>> client.delete_service_attributes(service_id='arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678', attributes=['Port'])
Source code in docs_src/capo_servicediscovery/_services/service_discovery.py
def delete_service_attributes(
    self,
    service_id: "capo_servicediscovery.types.arn.Arn",
    attributes: "capo_servicediscovery.types.service_attribute_key_list.ServiceAttributeKeyList",
    *,
    config_overrides: Optional[ServiceDiscoveryClientConfig] = None,
) -> "capo_servicediscovery.types.delete_service_attributes_response.DeleteServiceAttributesResponse":
    """<p>Deletes specific attributes associated with a service.</p>

    Args:
        service_id: <p>The ID or Amazon Resource Name (ARN) of the service from which the attributes will be deleted. For services created in a namespace shared with your Amazon Web Services account, specify the service ARN. For more information about shared namespaces, see <a href="https://docs.aws.amazon.com/cloud-map/latest/dg/sharing-namespaces.html">Cross-account Cloud Map namespace sharing</a> in the <i>Cloud Map Developer Guide</i>.</p>
        attributes: <p>A list of keys corresponding to each attribute that you want to delete.</p>

    Raises:
        capo_servicediscovery.errors.invalid_input.InvalidInput: <p>One or more specified values aren't valid. For example, a required value might be missing, a numeric value might be outside the allowed range, or a string value might exceed length constraints.</p>
        capo_servicediscovery.errors.service_not_found.ServiceNotFound: <p>No service exists with the specified ID.</p>
        capo_servicediscovery.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        DeleteServiceAttributes example
        Example: Delete service attribute by providing attribute key and service ID

        >>> client.delete_service_attributes(attributes=['port'], service_id='srv-e4anhexample0004')
        Delete service attributes using service ARN
        Deletes service attributes using a service ARN instead of service ID, useful for cross-account scenarios or when working with shared namespaces.

        >>> client.delete_service_attributes(service_id='arn:aws:servicediscovery:us-west-2:123456789012:service/srv-abcd1234xmpl5678', attributes=['Port'])
    """

    def _handler(
        req: "OperationRequest[capo_servicediscovery.types.delete_service_attributes_request.DeleteServiceAttributesRequest]",
    ) -> OperationResponse[
        "capo_servicediscovery.types.delete_service_attributes_response.DeleteServiceAttributesResponse"
    ]:
        import capo_servicediscovery._operations.route53_auto_naming_v20170314.delete_service_attributes

        output, http_response = (
            capo_servicediscovery._operations.route53_auto_naming_v20170314.delete_service_attributes.delete_service_attributes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DeleteServiceAttributes")
    )
    input_: capo_servicediscovery.types.delete_service_attributes_request.DeleteServiceAttributesRequest = {
        "service_id": service_id,
        "attributes": attributes,
    }

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