Skip to content

IAM  >  Operations  >  upload_server_certificate

upload_server_certificate

Operation

upload_server_certificate async 

upload_server_certificate(input: UploadServerCertificateInput, plugins: list[Plugin] | None = None) -> UploadServerCertificateOutput

Uploads a server certificate entity for the Amazon Web Services account. The server certificate entity includes a public key certificate, a private key, and an optional certificate chain, which should all be PEM-encoded.

We recommend that you use Certificate Manager to provision, manage, and deploy your server certificates. With ACM you can request a certificate, deploy it to Amazon Web Services resources, and let ACM handle certificate renewals for you. Certificates provided by ACM are free. For more information about using ACM, see the Certificate Manager User Guide.

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

For information about the number of server certificates you can upload, see IAM and STS quotas in the IAM User Guide.

Note

Because the body of the public key certificate, private key, and the certificate chain can be large, you should use POST rather than GET when calling UploadServerCertificate. 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 Calling the API by making HTTP query requests in the IAM User Guide.

Parameters:

Name Type Description Default
input UploadServerCertificateInput

An instance of UploadServerCertificateInput.

 required
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
UploadServerCertificateOutput

An instance of UploadServerCertificateOutput.

Input

UploadServerCertificateInput dataclass

Bases: _SerdeShape

Dataclass for UploadServerCertificateInput structure.

Attributes

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

The contents of the public key certificate in PEM-encoded format.

The [regex pattern](http://wikipedia.org/wiki/regex) used to validate
this parameter is a string of characters consisting of the following:

- Any printable ASCII character ranging from the space character
  (` `) through the end of the ASCII character range

- The printable characters in the Basic Latin and Latin-1 Supplement
  character set (through `ÿ`)

- The special characters tab (`     `), line feed (`

), and carriage return ( `)

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

The contents of the certificate chain. This is typically a concatenation
of the PEM-encoded public key certificates of the chain.

The [regex pattern](http://wikipedia.org/wiki/regex) used to validate
this parameter is a string of characters consisting of the following:

- Any printable ASCII character ranging from the space character
  (` `) through the end of the ASCII character range

- The printable characters in the Basic Latin and Latin-1 Supplement
  character set (through `ÿ`)

- The special characters tab (`     `), line feed (`

), and carriage return ( `)

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

The path for the server certificate. For more information about paths, see IAM identifiers in the IAM User Guide.

This parameter is optional. If it is not included, it defaults to a slash (/). This parameter allows (through its regex pattern) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (!) through the DEL character (), including most punctuation characters, digits, and upper and lowercased letters.

Note

If you are uploading a server certificate specifically for use with Amazon CloudFront distributions, you must specify a path using the path parameter. The path must begin with /cloudfront and must include a trailing slash (for example, /cloudfront/test/).

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

The contents of the private key in PEM-encoded format.

The [regex pattern](http://wikipedia.org/wiki/regex) used to validate
this parameter is a string of characters consisting of the following:

- Any printable ASCII character ranging from the space character
  (` `) through the end of the ASCII character range

- The printable characters in the Basic Latin and Latin-1 Supplement
  character set (through `ÿ`)

- The special characters tab (`     `), line feed (`

), and carriage return ( `)

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

The name for the server certificate. Do not include the path in this value. The name of the certificate cannot contain any spaces.

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: _+=,.@-

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

A list of tags that you want to attach to the new IAM server certificate resource. Each tag consists of a key name and an associated value. For more information about tagging, see Tagging IAM resources in the IAM User Guide.

Note

If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.

Output

UploadServerCertificateOutput dataclass

Bases: _SerdeShape

Contains the response to a successful UploadServerCertificate request.

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.

server_certificate_metadata class-attribute instance-attribute 
server_certificate_metadata: ServerCertificateMetadata | None = ...

The meta information of the uploaded server certificate without its certificate body, certificate chain, and private key.

tags class-attribute instance-attribute 
tags: list[Tag] | None = ...

A list of tags that are attached to the new IAM server certificate. The returned list of tags is sorted by tag key. For more information about tagging, see Tagging IAM resources in the IAM User Guide.