UpdateServerCertificate
Updates the name and/or the path of the specified server certificate stored in IAM.
For more information about working with server certificates, see Working with server certificates in the IAM User Guide. This topic also includes a list of AWS services that can use the server certificates that you manage with IAM.
Important
You should understand the implications of changing a server certificate's path or name. For more information, see Renaming a server certificate in the IAM User Guide.
Note
The person making the request (the principal), must have permission to change the
server certificate with the old name and the new name. For example, to change the
certificate named ProductionCert
to ProdCert
, the
principal must have a policy that allows them to update both certificates. If the
principal has permission to update the ProductionCert
group, but not
the ProdCert
certificate, then the update fails. For more information
about permissions, see Access management in the IAM User Guide.
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
- NewPath
-
The new path for the server certificate. Include this only if you are updating the server certificate's path.
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 ! ( \u0021
) through the DEL character (\u007F
), including most punctuation characters, digits, and upper and lowercased letters.Type: String
Length Constraints: Minimum length of 1. Maximum length of 512.
Pattern:
(\u002F)|(\u002F[\u0021-\u007E]+\u002F)
Required: No
- NewServerCertificateName
-
The new name for the server certificate. Include this only if you are updating the server certificate's name. 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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+
Required: No
- ServerCertificateName
-
The name of the server certificate that you want to update.
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: _+=,.@- Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
[\w+=,.@-]+
Required: Yes
Errors
For information about the errors that are common to all actions, see Common Errors.
- EntityAlreadyExists
-
The request was rejected because it attempted to create a resource that already exists.
HTTP Status Code: 409
- LimitExceeded
-
The request was rejected because it attempted to create resources beyond the current AWS account limits. The error message describes the limit exceeded.
HTTP Status Code: 409
- NoSuchEntity
-
The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
HTTP Status Code: 404
- ServiceFailure
-
The request processing has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
Examples
Example
This example illustrates one usage of UpdateServerCertificate.
Sample Request
https://iam.amazonaws.com/?Action=UpdateServerCertificate
&ServerCertificateName=OldProdServerCertName
&NewServerCertificateName=NewProdServerCertName
&Version=2010-05-08
&AUTHPARAMS
Sample Response
<UpdateServerCertificateResponse xmlns="https://iam.amazonaws.com/doc/2010-05-08/">
<ResponseMetadata>
<RequestId>7a62c49f-347e-4fc4-9331-6e8eEXAMPLE</RequestId>
</ResponseMetadata>
</UpdateServerCertificateResponse>
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: