Skip to content

IAM  >  Operations  >  upload_signing_certificate

upload_signing_certificate

Operation

upload_signing_certificate async

upload_signing_certificate(request: UploadSigningCertificateInput | UploadSigningCertificateInputDict, /, *, plugins: list[Plugin] | None = None) -> UploadSigningCertificateOutput
upload_signing_certificate(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[UploadSigningCertificateInputDict]) -> UploadSigningCertificateOutput

Uploads an X.509 signing certificate and associates it with the specified IAM user. Some Amazon Web Services services require you to use certificates to validate requests that are signed with a corresponding private key. When you upload the certificate, its default status is Active.

For information about when you would use an X.509 signing certificate, see Managing server certificates in IAM in the IAM User Guide.

If the UserName is not specified, the IAM 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.

Note

Because the body of an X.509 certificate can be large, you should use POST rather than GET when calling UploadSigningCertificate. For information about setting up signatures and authorization through the API, see Signing Amazon Web Services API requests in the Amazon Web Services General Reference. For general information about using the Query API with IAM, see Making query requests in the IAM User Guide.

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
UploadSigningCertificateOutput

An instance of UploadSigningCertificateOutput.

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

UploadSigningCertificateInput dataclass

Bases: _SerdeShape

Dataclass for UploadSigningCertificateInput structure.

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

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

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

The name of the user the signing certificate is for.

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

UploadSigningCertificateInputDict

Bases: TypedDict

Dictionary form of UploadSigningCertificateInput.

Attributes
certificate_body instance-attribute
certificate_body: Required[str]

The contents of the signing certificate.

The regex pattern used to validate this parameter is a string of characters consisting of the following:

  • Any printable ASCII character ranging from the space character (\u0020) through the end of the ASCII character range

  • The printable characters in the Basic Latin and Latin-1 Supplement character set (through \u00FF)

  • The special characters tab (\u0009), line feed (\u000A), and carriage return (\u000D)

user_name instance-attribute
user_name: str | None

The name of the user the signing certificate is for.

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

UploadSigningCertificateOutput dataclass

Bases: _SerdeShape

Contains the response to a successful UploadSigningCertificate request.

Attributes

certificate instance-attribute
certificate: SigningCertificate

Information about the certificate.

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.