Class UploadServerCertificateCommandProtected

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

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
//     },
//   ],
// };

Param

UploadServerCertificateCommandInput

Returns

UploadServerCertificateCommandOutput

See

• UploadServerCertificateCommandInput for command's input shape.
• UploadServerCertificateCommandOutput for command's response shape.
• config for IAMClient's config shape.

Throws

ConcurrentModificationException (client fault)

The request was rejected because multiple requests to change this object were submitted simultaneously. Wait a few minutes and submit your request again.

Throws

EntityAlreadyExistsException (client fault)

The request was rejected because it attempted to create a resource that already exists.

Throws

InvalidInputException (client fault)

The request was rejected because an invalid or out-of-range value was supplied for an input parameter.

Throws

KeyPairMismatchException (client fault)

The request was rejected because the public key certificate and the private key do not match.

Throws

LimitExceededException (client fault)

The request was rejected because it attempted to create resources beyond the current Amazon Web Services account limits. The error message describes the limit exceeded.

Throws

MalformedCertificateException (client fault)

The request was rejected because the certificate was malformed or expired. The error message describes the specific error.

Throws

ServiceFailureException (server fault)

The request processing has failed because of an unknown error, exception or failure.

Throws

IAMServiceException

Base exception class for all service exceptions from IAM service.

Example

To upload a server certificate to your AWS account

// The following upload-server-certificate command uploads a server certificate to your AWS account:
const input = {
  "CertificateBody": "-----BEGIN CERTIFICATE-----<a very long certificate text string>-----END CERTIFICATE-----",
  "Path": "/company/servercerts/",
  "PrivateKey": "-----BEGIN DSA PRIVATE KEY-----<a very long private key string>-----END DSA PRIVATE KEY-----",
  "ServerCertificateName": "ProdServerCert"
};
const command = new UploadServerCertificateCommand(input);
const response = await client.send(command);
/* response ==
{
  "ServerCertificateMetadata": {
    "Arn": "arn:aws:iam::123456789012:server-certificate/company/servercerts/ProdServerCert",
    "Expiration": "2012-05-08T01:02:03.004Z",
    "Path": "/company/servercerts/",
    "ServerCertificateId": "ASCA1111111111EXAMPLE",
    "ServerCertificateName": "ProdServerCert",
    "UploadDate": "2010-05-08T01:02:03.004Z"
  }
}
*/
// example id: 06eab6d1-ebf2-4bd9-839d-f7508b9a38b6