Skip to content

IAM  >  Operations  >  update_signing_certificate

update_signing_certificate

Operation

update_signing_certificate async

update_signing_certificate(request: UpdateSigningCertificateInput | UpdateSigningCertificateInputDict, /, *, plugins: list[Plugin] | None = None) -> UpdateSigningCertificateOutput
update_signing_certificate(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateSigningCertificateInputDict]) -> UpdateSigningCertificateOutput

Changes the status of the specified user signing certificate from active to disabled, or vice versa. This operation can be used to disable an IAM user's signing certificate as part of a certificate rotation work flow.

If the UserName field is not specified, the user name is determined implicitly based on the Amazon Web Services access key ID used to sign the request. This operation works for access keys under the Amazon Web Services account. Consequently, you can use this operation to manage Amazon Web Services account root user credentials even if the Amazon Web Services account has no associated users.

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
UpdateSigningCertificateOutput

An instance of UpdateSigningCertificateOutput.

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

UpdateSigningCertificateInput dataclass

Bases: _SerdeShape

Dataclass for UpdateSigningCertificateInput structure.

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

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

status class-attribute instance-attribute
status: str | None = ...

The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

user_name class-attribute instance-attribute
user_name: str | None = ...

The name of the IAM user the signing certificate belongs to.

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

UpdateSigningCertificateInputDict

Bases: TypedDict

Dictionary form of UpdateSigningCertificateInput.

Attributes
certificate_id instance-attribute
certificate_id: Required[str]

The ID of the signing certificate you want to update.

This parameter allows (through its regex pattern) a string of characters that can consist of any upper or lowercased letter or digit.

status instance-attribute
status: Required[str]

The status you want to assign to the certificate. Active means that the certificate can be used for programmatic calls to Amazon Web Services Inactive means that the certificate cannot be used.

user_name instance-attribute
user_name: str | None

The name of the IAM user the signing certificate belongs to.

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

UpdateSigningCertificateOutput dataclass

Bases: _SerdeShape

Dataclass for UpdateSigningCertificateOutput 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.