Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

UploadServerCertificateCommand

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.

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IAMClient, UploadServerCertificateCommand } from "@aws-sdk/client-iam"; // ES Modules import
// const { IAMClient, UploadServerCertificateCommand } = require("@aws-sdk/client-iam"); // CommonJS import
const client = new IAMClient(config);
const input = { // UploadServerCertificateRequest
  Path: "STRING_VALUE",
  ServerCertificateName: "STRING_VALUE", // required
  CertificateBody: "STRING_VALUE", // required
  PrivateKey: "STRING_VALUE", // required
  CertificateChain: "STRING_VALUE",
  Tags: [ // tagListType
    { // Tag
      Key: "STRING_VALUE", // required
      Value: "STRING_VALUE", // required
    },
  ],
};
const command = new UploadServerCertificateCommand(input);
const response = await client.send(command);
// { // UploadServerCertificateResponse
//   ServerCertificateMetadata: { // ServerCertificateMetadata
//     Path: "STRING_VALUE", // required
//     ServerCertificateName: "STRING_VALUE", // required
//     ServerCertificateId: "STRING_VALUE", // required
//     Arn: "STRING_VALUE", // required
//     UploadDate: new Date("TIMESTAMP"),
//     Expiration: new Date("TIMESTAMP"),
//   },
//   Tags: [ // tagListType
//     { // Tag
//       Key: "STRING_VALUE", // required
//       Value: "STRING_VALUE", // required
//     },
//   ],
// };

Example Usage

Loading code editor