Skip to content

IAM  >  Operations  >  delete_server_certificate

delete_server_certificate

Operation

delete_server_certificate async

delete_server_certificate(request: DeleteServerCertificateInput | DeleteServerCertificateInputDict, /, *, plugins: list[Plugin] | None = None) -> DeleteServerCertificateOutput
delete_server_certificate(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteServerCertificateInputDict]) -> DeleteServerCertificateOutput

Deletes the specified server certificate.

For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of Amazon Web Services services that can use the server certificates that you manage with IAM.

Warning

If you are using a server certificate with Elastic Load Balancing, deleting the certificate could have implications for your application. If Elastic Load Balancing doesn't detect the deletion of bound certificates, it may continue to use the certificates. This could cause Elastic Load Balancing to stop accepting traffic. We recommend that you remove the reference to the certificate from Elastic Load Balancing before using this command to delete the certificate. For more information, see DeleteLoadBalancerListeners in the Elastic Load Balancing API Reference.

Parameters:

Name Type Description Default
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

None

Returns:

Type Description
DeleteServerCertificateOutput

An instance of DeleteServerCertificateOutput.

Input

Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.

Model

DeleteServerCertificateInput dataclass

Bases: _SerdeShape

Dataclass for DeleteServerCertificateInput structure.

Attributes
server_certificate_name class-attribute instance-attribute
server_certificate_name: str | None = ...

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Dictionaries

DeleteServerCertificateInputDict

Bases: TypedDict

Dictionary form of DeleteServerCertificateInput.

Attributes
server_certificate_name instance-attribute
server_certificate_name: Required[str]

The name of the server certificate you want to delete.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-

Output

DeleteServerCertificateOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteServerCertificateOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.